index.md

---

geometalab.osm-pbf-file-size-estimation-service

Rough estimate for a certain extent for pbf file size.

---

Overview

Rough estimate for a certain extent for pbf file size.

Requirements

• Python (3.7, 3.8, 3.9)
• Django (2, 3)

Installation

Install using pip...

pip install geometalab.osm-pbf-file-size-estimation-service

Example

TODO: Write example.

Testing

Install testing requirements.

poetry install

Run with runtests.

poetry run ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install the python interpreters (3.7, 3.9), and then simply run:

poetry run tox

Alternatively using docker:

./tox_run.sh

Documentation

To build the documentation, you'll need to install the depenencies, using poetry:

poetry install

To preview the documentation:

poetry run mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

poetry run mkdocs build

Publish/Build

To publish a new release:

• change the version in pyproject.toml

then build:

poetry build

and publish:

poetry publish

and tag it:

git tag -a <version> -m "new release <version>"
git push