diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..12b72e42 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,17 @@ +MIT License +Copyright (c) 2020 YOUR NAME +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 00000000..0e36209c --- /dev/null +++ b/MANIFEST @@ -0,0 +1,6 @@ +# file GENERATED by distutils, do NOT edit +setup.cfg +setup.py +scadnano\__init__.py +scadnano\origami_rectangle.py +scadnano\scadnano.py diff --git a/README.md b/README.md index 3f21ed50..cd6d3d6d 100644 --- a/README.md +++ b/README.md @@ -8,40 +8,38 @@ This module is used to write Python scripts outputting *.dna files readable by [ The scadnano Python package requires [Python version 3.7](https://www.python.org/downloads/) or later. -There are two ways you can install it: +There are two ways you can install the scadnano Python package: -### pip +1. pip -1. If your Python installation does not already have pip installed, you may have to install it. -Executing [this Python script](https://bootstrap.pypa.io/get-pip.py) should work; -see also -https://docs.python.org/3/installing/index.html -or -https://www.liquidweb.com/kb/install-pip-windows/. - -2. Clone this repository by downloading [Git](https://git-scm.com/) and executing the following at the command line: + Use pip to install the package by executing the following at the command line: ```console - git clone https://github.com/UC-Davis-molecular-computing/scadnano-python-package.git + pip install scadnano ``` + If your Python installation does not already have pip installed, you may have to install it. + Executing [this Python script](https://bootstrap.pypa.io/get-pip.py) should work; + see also + https://docs.python.org/3/installing/index.html + or + https://www.liquidweb.com/kb/install-pip-windows/. -3. Use pip to install the package from the local repository by executing the following at the command line from the same directory where you executed the git command above: - ```console - pip install -e scadnano-python-package/ - ``` +2. download -### download -As a simple alternative, you can download and place the following file(s) (located in the [scadnano/ subfolder](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/scadnano)) in your PYTHONPATH (e.g., in the same directory as the scripts you are running): + As a simple alternative, you can download and place the following file(s) (located in the [scadnano/ subfolder](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/scadnano)) in your PYTHONPATH (e.g., in the same directory as the scripts you are running): -* *required*: [scadnano.py](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/blob/master/scadnano/scadnano.py) -* *optional*: [origami_rectangle.py](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/blob/master/scadnano/origami_rectangle.py); This can help create origami rectangles, but it is not necessary to use scadnano. - -## Examples - -Several example scripts are located in the [examples/](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/examples) subfolder. Their output is contained in the [examples/output_designs/](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/examples/output_designs) subfolder. + * *required*: [scadnano.py](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/blob/master/scadnano/scadnano.py) + * *optional*: [origami_rectangle.py](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/blob/master/scadnano/origami_rectangle.py); This can help create origami rectangles, but it is not necessary to use scadnano. ## Documentation Online documentation of the package API is located here: -https://web.cs.ucdavis.edu/~doty/scadnano/docs/ \ No newline at end of file +https://web.cs.ucdavis.edu/~doty/scadnano/docs/ + +## Examples + +Several example scripts are located in the +[examples/](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/examples) subfolder. +Their output is contained in the +[examples/output_designs/](https://github.com/UC-Davis-molecular-computing/scadnano-python-package/tree/master/examples/output_designs) subfolder. diff --git a/dist/scadnano-0.0.1.tar.gz b/dist/scadnano-0.0.1.tar.gz new file mode 100644 index 00000000..f32da961 Binary files /dev/null and b/dist/scadnano-0.0.1.tar.gz differ diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..224a7795 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md \ No newline at end of file diff --git a/setup.py b/setup.py index cd7abeb7..0bbeda13 100644 --- a/setup.py +++ b/setup.py @@ -3,10 +3,12 @@ from distutils.core import setup setup(name='scadnano', + packages=['scadnano'], version='0.0.1', - description="", - author="", - author_email="", - url="", - packages=['scadnano'] + license='MIT', + description="Python scripting library for generating designs readable by scadnano.", + author="David Doty", + author_email="doty@ucdavis.edu", + url="https://github.com/UC-Davis-molecular-computing/scadnano-python-package", + download_url = 'https://github.com/UC-Davis-molecular-computing/scadnano-python-package/???', )