feature: setup.py corrections and proper version

Author: herbiebradley

MANIFEST.in

@@ -1,3 +1,3 @@
 include MANIFEST.in
-include README.md
+include PYPI_README.md
 include LICENSE

PYPI_README.md

@@ -0,0 +1,49 @@
+<p align="center">
+<img src="https://raw.githubusercontent.com/ai4er-cdt/gtc-biodiversity/main/docs/images/geograph_logo.png" alt="GeoGraph" width="300px">
+</p>
+
+_Created as part of the AI4ER Group Team Challenge 2021 by the Biodiversity Team._
+
+
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ai4er-cdt/gtc-biodiversity/main?urlpath=lab%2Ftree%2Fnotebooks)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+[![Documentation Status](https://readthedocs.org/projects/geograph/badge/?version=latest)](https://geograph.readthedocs.io/en/latest/?badge=latest)
+
+
+__Table of contents:__
+1. Features
+2. Getting started
+3. Requirements
+4. Documentation
+5. Project structure
+
+## 1. Features
+
+GeoGraph provides a full-stack tool for analysing habitat fragmentation, and other related problems. It includes models to predict land cover classes, a method to extract graph structure from the resulting land cover maps and an extensive range of visualisation and analysis tools.
+
+## 2. Getting started
+
+Clone this repository using
+
+```
+git clone https://github.com/ai4er-cdt/gtc-biodiversity.git
+```
+
+Enter the directory and install the conda environment using
+
+```
+cd gtc-biodiversity
+make env
+```
+
+Done, you're ready to go!
+
+## 3. Requirements
+
+GeoGraph is written in Python 3.8 and builds on [NetworkX](https://github.com/NetworkX/NetworkX), [ipyleaflet](https://github.com/jupyter-widgets/ipyleaflet) and many more packages. See the [requirements directory](./requirements) for a full list of dependencies.
+
+## 4. Documentation
+
+Our documentation is available at [geograph.readthedocs.io](https://geograph.readthedocs.io/).
+

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-<img src="https://raw.githubusercontent.com/ai4er-cdt/gtc-biodiversity/main/docs/images/geograph_logo.png" alt="GeoGraph" width="300px">
+<img src="docs/images/geograph_logo.png" alt="GeoGraph" width="300px">
 </p>
 
 _Created as part of the AI4ER Group Team Challenge 2021 by the Biodiversity Team._
@@ -10,7 +10,7 @@ _Created as part of the AI4ER Group Team Challenge 2021 by the Biodiversity Team
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 [![Documentation Status](https://readthedocs.org/projects/geograph/badge/?version=latest)](https://geograph.readthedocs.io/en/latest/?badge=latest)
 
- ![GeoGraphViewer demo gif](https://raw.githubusercontent.com/ai4er-cdt/gtc-biodiversity/main/docs/images/viewer_demo.gif)
+![GeoGraphViewer demo gif](docs/images/viewer_demo.gif)
 
 
 __Table of contents:__

geograph/_version.py

@@ -0,0 +1,2 @@
+"""Module to store the __version__ string."""
+__version__ = "0.0.1"

setup.py

@@ -1,7 +1,11 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-"""Module that defines a setup function and publishes the package to PyPI."""
+"""
+Module that defines a setup function and publishes the package to PyPI.
+
+Use the command `python setup.py upload`.
+"""
 # Note: To use the "upload" functionality of this file, you must:
 #   $ pip install twine
 
@@ -15,7 +19,7 @@
 
 # Package meta-data.
 NAME = "geograph"
-DESCRIPTION = "Group Team Challenge 2021; Biodiversity Team."
+DESCRIPTION = "Group Team Challenge 2021 - Biodiversity Team"
 URL = "https://geograph.readthedocs.io/"
 EMAIL = "[email protected]"
 AUTHOR = "Biodiversity Team"
@@ -43,18 +47,17 @@
 
 here = os.path.abspath(os.path.dirname(__file__))
 
-# Import the README and use it as the long-description.
-# Note: this will only work if "README.md" is present in your MANIFEST.in file!
+# Import the PYPI README and use it as the long-description.
+# Note: this will only work if "PYPI_README.md" is present in your MANIFEST.in file!
 try:
-    with io.open(os.path.join(here, "README.md"), encoding="utf-8") as f:
+    with io.open(os.path.join(here, "PYPI_README.md"), encoding="utf-8") as f:
         long_description = "\n" + f.read()
 except FileNotFoundError:
     long_description = DESCRIPTION
 
 # Load the package"s _version.py module as a dictionary.
 about: Dict = {}
-project_slug = "src".lower().replace("-", "_").replace(" ", "_")
-with open(os.path.join(here, project_slug, "_version.py")) as f:
+with open(os.path.join(here, NAME, "_version.py")) as f:
     # pylint: disable=exec-used
     exec(f.read(), about)
 
@@ -77,7 +80,7 @@ def finalize_options(self):
         pass
 
     def run(self):
-        "Publish package to PyPI."
+        """Publish package to PyPI."""
         try:
             self.status("Removing previous builds…")
             rmtree(os.path.join(here, "dist"))
@@ -88,11 +91,11 @@ def run(self):
         os.system("{0} setup.py sdist bdist_wheel --universal".format(sys.executable))
 
         self.status("Uploading the package to PyPI via Twine…")
-        os.system("twine upload --repository-url https://test.pypi.org/legacy/ dist/*")
+        os.system("twine upload dist/*")
 
-        # self.status("Pushing git tags…")
-        # os.system("git tag v{0}".format(about["__version__"]))
-        # os.system("git push --tags")
+        self.status("Pushing git tags…")
+        os.system("git tag v{0}".format(about["__version__"]))
+        os.system("git push --tags")
 
         sys.exit()
 
@@ -139,5 +142,5 @@ def run(self):
     cmdclass={
         "upload": UploadCommand,
     },
-    test_suite="src.tests.test_all.suite",
+    test_suite="geograph.tests.test_all.suite",
 )