Skip to content

Commit

Permalink
Dependencies update and refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
frafra committed Aug 3, 2024
1 parent a0c8c50 commit a7afadd
Show file tree
Hide file tree
Showing 11 changed files with 235 additions and 307 deletions.
6 changes: 0 additions & 6 deletions .dockerignore

This file was deleted.

172 changes: 172 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,176 @@
# Created by https://www.toptal.com/developers/gitignore/api/python
# Edit at https://www.toptal.com/developers/gitignore?templates=python

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json

# End of https://www.toptal.com/developers/gitignore/api/python
18 changes: 5 additions & 13 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
FROM python:3.7-slim
LABEL maintainer="[email protected]"

WORKDIR /src
ADD poetry.lock pyproject.toml ./

RUN pip install poetry && \
poetry install --no-root --no-dev

ADD . .

FROM python:3.11-alpine AS base
RUN --mount=type=bind,target=/pkg,rw \
--mount=type=cache,target=/root/.cache/pip \
pip install /pkg
EXPOSE 8000

CMD ["/usr/local/bin/poetry", "run", "uvicorn", "--host", "0.0.0.0", "gpapconv:app"]
CMD ["uvicorn", "--host", "0.0.0.0", "gpapconv:app"]
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,27 @@ Geopaparazzi to OSM XML and GeoJSON converter

Demo: https://gpapconv.frafra.eu/

## Dependencies
## Technologies

- [Python 3](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [Uvicorn](https://www.uvicorn.org/)
- [Poetry](poetry.eustace.io/)
- [sqlite](https://sqlite.org/)

## Setup

### uwsgi
### Classic

```
$ poetry install --no-root --no-dev
$ poetry run uvicorn gpapconv:app
```bash
python3 -m venv venv
source venv/bin/activate
pip install -e .
```

### Docker image
### Docker

```
$ docker build --tag=gpapconv .
$ docker run --publish 8000:8000 --detach gpapconv
```bash
docker compose up --build
```

## How to use
Expand All @@ -38,12 +37,12 @@ Open http://localhost:8000.

From gpap to OSM XML:

```
$ curl -X POST -F "[email protected]" http://localhost:8000/gpap2osm
```bash
curl -X POST -F "[email protected]" http://localhost:8000/gpap2osm
```

From gpap to OSM GeoJSON:

```
$ curl -X POST -F "[email protected]" http://localhost:8000/gpap2geojson
```bash
curl -X POST -F "[email protected]" http://localhost:8000/gpap2geojson
```
5 changes: 5 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
services:
gpapconv:
build: .
ports:
- 8000:8000
Loading

0 comments on commit a7afadd

Please sign in to comment.