Releasing version 0.1.0

Author: adamcharnock

README.md

@@ -46,6 +46,9 @@ python
 ## Release process
 
 ```
+# Run the tests
+pytest
+
 # Update the setup.py
 dephell convert
 black setup.py
@@ -70,4 +73,6 @@ git push origin \
     refs/tags/"v$VERSION" \
     refs/heads/"v$VERSION" \
     master
+
+poetry publish --build
 ```

README.rst

@@ -0,0 +1,83 @@
+
+NASA SRTM altitude data parsing in Python
+=========================================
+
+Provides an API onto SRTM ``.hgt`` or ``.hgt.zip`` files.
+
+Requires Python 3.8, **may** work with Python 3.6 & 3.7.
+
+Installation
+------------
+
+.. code-block::
+
+   pip install python-srtm
+
+   export SRTM1_DIR=/path/to/srtm1/
+   export SRTM3_DIR=/path/to/srtm3/
+
+Use
+---
+
+You can access either SRTM1 or SRTM3 data. SRTM 1, for example:
+
+.. code-block:: python
+
+   # SRTM1
+   python
+
+   >>> from srtm import Srtm1HeightMapCollection
+   >>> srtm1_data = Srtm1HeightMapCollection()
+   >>> srtm1_data.get_altitude(latitude=40.123, longitude=-7.456)
+   615
+   >>> Srtm1HeightMapCollection().get_elevation_profile(40.123, -7.456, 40.129, -7.460)
+   [615, 620, 618, 620, 616, 603, 593, 582, 575, 579, 580, 589, 589, 581, 565, 553, 545, 541, 534, 533, 529, 520, 514]
+
+Or SRTM3:
+
+.. code-block:: python
+
+   # SRTM3
+   python
+
+   >>> from srtm import Srtm3HeightMapCollection
+   >>> srtm3_data = Srtm3HeightMapCollection()
+   >>> srtm3_data.get_altitude(latitude=40.123, longitude=-7.456)
+   608
+   >>> Srtm3HeightMapCollection().get_elevation_profile(40.123, -7.456, 40.129, -7.460)
+   [626, 616, 585, 593, 577, 548, 528, 514]
+
+Release process
+---------------
+
+.. code-block::
+
+   # Run the tests
+   pytest
+
+   # Update the setup.py
+   dephell convert
+   black setup.py
+
+   # Ensure poetry.lock is up to date
+   poetry lock
+
+   export VERSION="VERSION HERE"
+
+   # Version bump
+   poetry version $VERSION
+
+
+   # Commit
+   git add .
+   git commit -m "Releasing version $VERSION"
+
+   # Tagging and branching
+   git tag "v$VERSION"
+   git branch "v$VERSION"
+   git push origin \
+       refs/tags/"v$VERSION" \
+       refs/heads/"v$VERSION" \
+       master
+
+   poetry publish --build

pyproject.toml

@@ -16,10 +16,10 @@ pytest = "^5.4.1"
 dephell = "^0.8.2"
 black = "^19.10b0"
 
+[tool.dephell.main]
+from = {format = "poetry", path = "pyproject.toml"}
+to = {format = "setuppy", path = "setup.py"}
 [build-system]
 requires = ["poetry>=0.12"]
 build-backend = "poetry.masonry.api"
 
-[tool.dephell.main]
-from = {format = "poetry", path = "pyproject.toml"}
-to = {format = "setuppy", path = "setup.py"}

setup.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+
+# DO NOT EDIT THIS FILE!
+# This file has been autogenerated by dephell <3
+# https://github.com/dephell/dephell
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+
+import os.path
+
+readme = ""
+here = os.path.abspath(os.path.dirname(__file__))
+readme_path = os.path.join(here, "README.rst")
+if os.path.exists(readme_path):
+    with open(readme_path, "rb") as stream:
+        readme = stream.read().decode("utf8")
+
+
+setup(
+    long_description=readme,
+    name="python-srtm",
+    version="0.1.0",
+    python_requires="==3.*,>=3.8.0",
+    project_urls={"repository": "https://github.com/adamcharnock/python-srtm"},
+    author="Adam Charnock",
+    author_email="[email protected]",
+    license="MIT",
+    keywords="nasa geospatial altitude elevation-profile",
+    packages=["srtm"],
+    package_dir={"": "."},
+    package_data={},
+    install_requires=[],
+    extras_require={
+        "dev": ["black==19.*,>=19.10.0", "dephell==0.*,>=0.8.2", "pytest==5.*,>=5.4.1"]
+    },
+)