Skip to content

Commit 9ca80c0

Browse files
vincentsaragovincentsarago
committed
init
0 parents  commit 9ca80c0

33 files changed

+46968
-0
lines changed

‎.bumpversion.cfg

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[bumpversion]
2+
current_version = 0.1.0
3+
commit = True
4+
tag = True
5+
tag_name = {new_version}
6+
7+
[bumpversion:file:tifeatures/__init__.py]
8+
search = __version__ = "{current_version}"
9+
replace = __version__ = "{new_version}"

‎.env.example

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
DATABASE_URL=postgresql://username:[email protected]:5439/postgis

‎.flake8

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[flake8]
2+
ignore = E501,W503,E203
3+
exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
4+
max-complexity = 12
5+
max-line-length = 90

‎.github/codecov.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
comment: off
2+
3+
coverage:
4+
status:
5+
project:
6+
default:
7+
target: auto
8+
threshold: 5

‎.github/workflows/ci.yml

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: CI
2+
3+
# On every pull request, but only on push to master
4+
on:
5+
push:
6+
branches:
7+
- master
8+
tags:
9+
- '*'
10+
paths:
11+
# Only run test and docker publish if somde code have changed
12+
- 'pyproject.toml'
13+
- 'tifeatures/**'
14+
- 'tests/**'
15+
- '.pre-commit-config.yaml'
16+
- 'dockerfiles/**'
17+
pull_request:
18+
env:
19+
LATEST_PY_VERSION: '3.9'
20+
21+
jobs:
22+
tests:
23+
runs-on: ubuntu-latest
24+
strategy:
25+
matrix:
26+
python-version: ['3.7', '3.8', '3.9']
27+
28+
steps:
29+
- uses: actions/checkout@v2
30+
- name: Set up Python ${{ matrix.python-version }}
31+
uses: actions/setup-python@v2
32+
with:
33+
python-version: ${{ matrix.python-version }}
34+
35+
- name: install lib postgres
36+
run: |
37+
sudo apt update
38+
wget -q https://www.postgresql.org/media/keys/ACCC4CF8.asc -O- | sudo apt-key add -
39+
echo "deb [arch=amd64] http://apt.postgresql.org/pub/repos/apt/ focal-pgdg main" | sudo tee /etc/apt/sources.list.d/postgresql.list
40+
sudo apt update
41+
sudo apt-get install --yes libpq-dev postgis postgresql-14-postgis-3
42+
43+
- name: Install dependencies
44+
run: |
45+
python -m pip install --upgrade pip
46+
python -m pip install codecov pre-commit
47+
48+
- name: Install module
49+
run: python -m pip install .["test"]
50+
51+
- name: Run pre-commit
52+
if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
53+
run: pre-commit run --all-files
54+
55+
- name: Run tests
56+
run: python -m pytest --cov tifeatures --cov-report xml --cov-report term-missing
57+
58+
- name: Upload Results
59+
if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
60+
uses: codecov/codecov-action@v1
61+
with:
62+
file: ./coverage.xml
63+
flags: unittests
64+
name: ${{ matrix.python-version }}
65+
fail_ci_if_error: false

‎.gitignore

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a template
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*.cover
47+
.hypothesis/
48+
49+
# Translations
50+
*.mo
51+
*.pot
52+
53+
# Django stuff:
54+
*.log
55+
local_settings.py
56+
57+
# Flask stuff:
58+
instance/
59+
.webassets-cache
60+
61+
# Scrapy stuff:
62+
.scrapy
63+
64+
# Sphinx documentation
65+
docs/_build/
66+
67+
# PyBuilder
68+
target/
69+
70+
# Jupyter Notebook
71+
.ipynb_checkpoints
72+
73+
# pyenv
74+
.python-version
75+
76+
# celery beat schedule file
77+
celerybeat-schedule
78+
79+
# SageMath parsed files
80+
*.sage.py
81+
82+
# dotenv
83+
.env
84+
85+
# virtualenv
86+
.venv
87+
venv/
88+
ENV/
89+
90+
# Spyder project settings
91+
.spyderproject
92+
.spyproject
93+
94+
# Rope project settings
95+
.ropeproject
96+
97+
# mkdocs documentation
98+
/site
99+
100+
# mypy
101+
.mypy_cache/
102+
103+
cdk.out/
104+
105+
# pycharm
106+
.idea/
107+
108+
benchmark/

‎.pre-commit-config.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
repos:
2+
- repo: https://github.com/psf/black
3+
rev: 22.3.0
4+
hooks:
5+
- id: black
6+
language_version: python
7+
8+
- repo: https://github.com/PyCQA/isort
9+
rev: 5.4.2
10+
hooks:
11+
- id: isort
12+
language_version: python
13+
14+
- repo: https://github.com/PyCQA/flake8
15+
rev: 3.8.3
16+
hooks:
17+
- id: flake8
18+
language_version: python
19+
20+
- repo: https://github.com/PyCQA/pydocstyle
21+
rev: 6.1.1
22+
hooks:
23+
- id: pydocstyle
24+
language_version: python
25+
additional_dependencies:
26+
- toml
27+
28+
- repo: https://github.com/pre-commit/mirrors-mypy
29+
rev: v0.812
30+
hooks:
31+
- id: mypy
32+
language_version: python

‎CHANGES.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release Notes
2+
3+
## 0.1.0
4+
5+
Initial release

‎CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Development - Contributing
2+
3+
Issues and pull requests are more than welcome: https://github.com/developmentseed/tifeatures/issues
4+
5+
**dev install**
6+
7+
```bash
8+
$ git clone https://github.com/developmentseed/tifeatures.git
9+
$ cd tifeatures
10+
$ pip install -e .[dev]
11+
```
12+
13+
**pre-commit**
14+
15+
This repo is set to use `pre-commit` to run *isort*, *flake8*, *pydocstring*, *black* ("uncompromising Python code formatter") and mypy when committing new code.
16+
17+
```bash
18+
$ pre-commit install
19+
```

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Development Seed
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<p align="center">
2+
<pre style="background-color: #FFF;">
3+
________ __ ________ __
4+
| \ \ | \ | \
5+
\▓▓▓▓▓▓▓▓\▓▓ | ▓▓▓▓▓▓▓▓ ______ ______ _| ▓▓_ __ __ ______ ______ _______
6+
| ▓▓ | \ | ▓▓__ / \ | \| ▓▓ \ | \ | \/ \ / \ / \
7+
| ▓▓ | ▓▓ | ▓▓ \ | ▓▓▓▓▓▓\ \▓▓▓▓▓▓\\▓▓▓▓▓▓ | ▓▓ | ▓▓ ▓▓▓▓▓▓\ ▓▓▓▓▓▓\ ▓▓▓▓▓▓▓
8+
| ▓▓ | ▓▓ | ▓▓▓▓▓ | ▓▓ ▓▓/ ▓▓ | ▓▓ __| ▓▓ | ▓▓ ▓▓ \▓▓ ▓▓ ▓▓\▓▓ \
9+
| ▓▓ | ▓▓ | ▓▓ | ▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓ | ▓▓| \ ▓▓__/ ▓▓ ▓▓ | ▓▓▓▓▓▓▓▓_\▓▓▓▓▓▓\
10+
| ▓▓ | ▓▓ | ▓▓ \▓▓ \\▓▓ ▓▓ \▓▓ ▓▓\▓▓ ▓▓ ▓▓ \▓▓ \ ▓▓
11+
\▓▓ \▓▓ \▓▓ \▓▓▓▓▓▓▓ \▓▓▓▓▓▓▓ \▓▓▓▓ \▓▓▓▓▓▓ \▓▓ \▓▓▓▓▓▓▓\▓▓▓▓▓▓▓
12+
13+
</pre>
14+
<p align="center">Simple and Fast Geospatial Feature Server for PostGIS.</p>
15+
</p>
16+
17+
<p align="center">
18+
<a href="https://github.com/developmentseed/tifeatures/actions?query=workflow%3ACI" target="_blank">
19+
<img src="https://github.com/developmentseed/tifeatures/workflows/CI/badge.svg" alt="Test">
20+
</a>
21+
<a href="https://codecov.io/gh/developmentseed/tifeatures" target="_blank">
22+
<img src="https://codecov.io/gh/developmentseed/tifeatures/branch/master/graph/badge.svg" alt="Coverage">
23+
</a>
24+
<a href="https://github.com/developmentseed/tifeatures/blob/master/LICENSE" target="_blank">
25+
<img src="https://img.shields.io/github/license/developmentseed/tifeatures.svg" alt="License">
26+
27+
</a>
28+
</p>
29+
30+
---
31+
32+
**Source Code**: <a href="https://github.com/developmentseed/tifeatures" target="_blank">https://github.com/developmentseed/tifeatures</a>
33+
34+
---
35+
36+
37+
## Install
38+
39+
```bash
40+
$ git clone https://github.com/developmentseed/tifeatures.git
41+
$ cd tifeatures
42+
$ python -m pip install -e .
43+
```
44+
45+
## Launch
46+
47+
```bash
48+
$ pip install uvicorn
49+
50+
$ uvicorn tifeatures.main:app
51+
```
52+
53+
![](https://user-images.githubusercontent.com/10407788/152539521-eadb9680-44ea-4647-b65d-d6644169db85.png)
54+
55+
### Configuration
56+
57+
To be able to work, the application will need access to the PostGIS database. `tifeatures` uses [starlette](https://www.starlette.io/config/)'s configuration pattern which make use of environment variable and/or `.env` file to pass variable to the application.
58+
59+
Example of `.env` file can be found in [.env.example](https://github.com/developmentseed/tifeatures/blob/master/.env.example)
60+
61+
```
62+
# you need define the DATABASE_URL directly
63+
DATABASE_URL=postgresql://username:[email protected]:5432/postgis
64+
```
65+
66+
## Contribution & Development
67+
68+
See [CONTRIBUTING.md](https://github.com/developmentseed/tifeatures/blob/master/CONTRIBUTING.md)
69+
70+
## License
71+
72+
See [LICENSE](https://github.com/developmentseed/tifeatures/blob/master/LICENSE)
73+
74+
## Authors
75+
76+
Created by [Development Seed](<http://developmentseed.org>)
77+
78+
## Changes
79+
80+
See [CHANGES.md](https://github.com/developmentseed/tifeatures/blob/master/CHANGES.md).
81+

0 commit comments

Comments
 (0)