release-1.0.0 (#51)

* add setup.py

* major version

* add changelog

* resolve mismatches

* update readme

* update readme

* update readme

* update setup.py

Author: geospatial-jeff

.gitignore

@@ -1,5 +1,4 @@
 PIP_EXTRA_INDEX_URL
-*.txt
 !tests/resources/*.jpg
 **.pyc
 **.log

CHANGELOG.txt

@@ -0,0 +1,3 @@
+1.0.0 (2020-09-25)
+------------------
+- First PyPi release!

Dockerfile

@@ -13,7 +13,7 @@ ARG install_dev_dependencies=true
 
 WORKDIR /app
 
-COPY Pipfile Pipfile.lock ./
+COPY Pipfile Pipfile.lock setup.py ./
 RUN pipenv install --deploy --ignore-pipfile ${install_dev_dependencies:+--dev}
 
 COPY . ./

Pipfile

@@ -4,19 +4,7 @@ url = "https://pypi.org/simple"
 verify_ssl = "true"
 
 [packages]
-uvicorn = ">=0.11.7"
-gunicorn = "*"
-fastapi = {extras = ["all"],version = "*"}
-alembic = "*"
-psycopg2-binary = "*"
-shapely = "*"
-sqlalchemy = "*"
-geoalchemy2 = "<0.8.0"
-sqlakeyset = "*"
-stac-pydantic = ">=1.3.5"
-pydantic = {extras=["dotenv"], version="*"}
-cogeo-mosaic = "==3.0a10"
-titiler = "==0.1a2"
+arturo-stac-api = {editable = "true", path = "."}
 
 [dev-packages]
 pytest = "*"

Pipfile.lock

@@ -1,20 +1,51 @@
 # arturo-stac-api ![arturo-stac-api](https://github.com/arturo-ai/arturo-stac-api/workflows/arturo-stac-api/badge.svg)
-FastAPI/postgres implementation of the [STAC API specification](https://github.com/radiantearth/stac-api-spec).
+---
+
+**Documentation**: coming soon...
+
+**Source Code**: [https://github.com/arturo-ai/arturo-stac-api](https://github.com/arturo-ai/arturo-stac-api)
+
+---
+
+Python library for building and customizing a STAC compliant API:
+
+
+```
+pip install arturo-stac-api
+```
+
+
+## Usage
+```python
+# my_app.py
+from stac_api.config import ApiSettings
+from stac_api.api import create_app
+
+settings = ApiSettings()
+app = create_app(settings)
+```
+
+```bash
+$ uvicorn my_app:app --reload
+```
 
 ## Project Structure
 ```
 .
 ├── alembic             # Database migrations
 │   └── versions        # Migration versions
-├── stac_api            
-│   ├── clients         # Database CRUD
-│   ├── models          # Database and API data models
-│   ├── resources       # API endpoints
-│   └── utils           # FastAPI dependencies
+├── scripts             # Scripts for local development
+├── stac_api
+│   ├── api             # API layer
+│   ├── clients
+│   │   ├── postgres    # Postgres CRUD client
+│   │   └── tiles       # OGC Tiles API client
+│   ├── models          # Pydantic and ORM models
+│   └── utils           # Helper functions
 └── tests
-    ├── clients         # CRUD test cases
-    ├── data            # Test data
-    └── resources       # API test cases
+    ├── api             # Test api creation
+    ├── clients         # Test application logic
+    └── resources       # Test api endpoints
 ```
 
 ## Local Development

README.md

@@ -0,0 +1,55 @@
+"""arturo-stac-api"""
+
+from setuptools import find_packages, setup
+
+with open("README.md") as f:
+    desc = f.read()
+
+
+install_requires = [
+    "uvicorn>=0.11.7",
+    "gunicorn",
+    "fastapi>=0.60.0",
+    "alembic",
+    "psycopg2-binary",
+    "shapely",
+    "sqlalchemy",
+    "geoalchemy2<0.8.0",
+    "sqlakeyset",
+    "stac-pydantic>=1.3.5",
+    "pydantic[dotenv]",
+    "cogeo-mosaic==3.0a10",
+    "titiler==0.1a2",
+    "rio-cogeo==2.0a5",
+]
+
+extra_reqs = {
+    "dev": ["pytest", "pytest-cov", "pytest-asyncio", "pre-commit", "requests"],
+}
+
+
+setup(
+    name="arturo-stac-api",
+    description="Arturo's STAC compliant API implementation",
+    long_description=desc,
+    long_description_content_type="text/markdown",
+    version="1.0.0",
+    python_requires=">=3.8",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Science/Research",
+        "Programming Language :: Python :: 3.8",
+        "License :: OSI Approved :: MIT License",
+    ],
+    keywords="STAC FastAPI COG",
+    author=u"Arturo Engineering",
+    author_email="engineering@arturo.ai",
+    url="https://github.com/arturo-ai/arturo-stac-api",
+    license="MIT",
+    packages=find_packages(exclude=["alembic", "tests", "scripts"]),
+    zip_safe=False,
+    install_requires=install_requires,
+    tests_require=extra_reqs["dev"],
+    extras_require=extra_reqs,
+)