PyPI Packaging

Author: Sampreet

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## v0.7.3 - 2021/06/10 - 01 - Removed TF Modules
+## v0.7.5 - 2021/06/10 - 00 - PyPI Packaging
+* Updated link to `CODE_OF_CONDUCT` in `CONTRIBUTING`.
+* Added `LICENSE` for BSD licensing.
+* Updated `requirements` and `setup`.
+* Updated `README`.
+
+## v0.7.3 - 2021/06/09 - 01 - Removed TF Modules
 * Updated documentation configuration in `docs`.
 * Removed `qom_tf` package.
 * Added `CODE_OF_CONDUCT` for GitHub pages configuration.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to The Quantum Optomechanics Toolbox
 
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg?style=for-the-badge)](./code_of_conduct.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.2-4baaaa.svg?style=for-the-badge)](./CODE_OF_CONDUCT.md)
 
 Feel free to contribute to the code by forking this repository in your profile.
 All pull requests from subsequent branches will be reviewed.
@@ -84,14 +84,17 @@ ROOT_DIR/
 │   ├───foo_bar.py
 │   └───...
 │
-├───.gitignore
 ├───_config.yml
+├───.gitignore
 ├───CHANGELOG.md
 ├───CODE_OF_CONDUCT.md
 ├───CONTRIBUTING.md
+├───LICENSE
 ├───MANIFEST.in
+├───pyproject.toml
 ├───README.md
 ├───requirements.txt
+├───setup.cfg
 └───setup.py
 ```
 

LICENSE

@@ -0,0 +1,32 @@
+The Clear BSD License
+
+Copyright (c) 2020 Sampreet Kalita
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the disclaimer
+below) provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+    * Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -31,15 +31,23 @@ Backed by numerical libraries like NumPy and SciPy, and featuring the highly cus
 
 ### Dependencies
 
-The project requires `Python 3.7+` installed, preferably via the [Anaconda distribution](https://www.anaconda.com/products/individual).
+The project requires `Python 3.8+` installed, preferably via the [Anaconda distribution](https://www.anaconda.com/products/individual).
 
-### Installing via `pip`
+### Installing from PyPI
 
-To install the package, download the repository as `.zip` and extract the contents.
+To install the package and its requirements from the Python Package Index, execute: 
+
+```bash
+pip install -i https://test.pypi.org/simple/ qom
+```
+
+### Installing Locally
+
+To install the package locally, download the repository as `.zip` and extract the contents.
 Now, execute the following from *outside* the top-level directory, `ROOT_DIR`, inside which `setup.py` is located:
 
 ```bash
-pip install ROOT_DIR
+pip install -e ROOT_DIR
 ```
 
 Once the package is installed, its modules can be imported.

requirements.txt

@@ -1,6 +1,7 @@
 # qom
-matplotlib>=3.0
-numpy>=1.10
-scipy>=1.0
-seaborn>=0.10
-setuptools>=40.0
+matplotlib>=3.3
+numpy>=1.19
+pyqt5>=5.9
+scipy>=1.5
+seaborn>=0.11
+sympy>=1.6

setup.py

@@ -4,32 +4,35 @@
     long_desc = file_readme.read()
 
 setup(
-    name='qom-toolbox',
-    version='0.7.3',
+    name='qom',
+    version='0.7.5',
     author='Sampreet Kalita',
     author_email='[email protected]',
-    desctiption='Quantum Optomechanics Toolbox',
+    desctiption='The Quantum Optomechanics Toolbox',
     long_description=long_desc,
     long_description_content_type='text/markdown',
-    url='http://github.com/sampreet/qom',
-    packages= find_packages(),
+    keywords=['quantum', 'optomechanics', 'toolbox', 'python3'],
+    url='https://github.com/sampreet/qom',
+    download_url='https://github.com/Sampreet/qom/archive/refs/tags/v0.7.5.tar.gz',
+    packages=find_packages(),
     classifiers=[
         'Programming Language :: Python :: 3',
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Science/Research',
-        'License :: OSI Approved :: MIT License',
+        'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',
         'Topic :: Scientific/Engineering'
     ],
-    license='MIT',
+    license='BSD',
     install_requires=[
-        'matplotlib>=3.0',
-        'numpy>=1.10',
-        'scipy>=1.0',
-        'seaborn>=0.10',
-        'setuptools>=40.0'
+        'matplotlib>=3.3',
+        'numpy>=1.19',
+        'pyqt5>=5.9',
+        'scipy>=1.5',
+        'seaborn>=0.11',
+        'sympy>=1.6'
     ],
-    python_requires='>=3.7',
+    python_requires='>=3.8',
     zip_safe=False,
     include_package_data=True
 )