PyODX

For the latest documentation visit: https://pyodx.webodm.org

The information below is for managing the repository.

Running Tests

python run_tests.py

Will run the all doctests. You must have a NodeODX node running in test mode locally to run the test suite:

docker run -ti -p 3000:3000 webodm/nodeodx --test

Building The Documentation

Make sure you are using Python 3.

pip install -r docs/requirements.txt

Serve the docs locally with live reload:

mkdocs serve

To stop the server press Ctrl+C.

Publishing to PyPI

pip install setuptools wheel twine
python setup.py sdist bdist_wheel
python -m twine upload dist/*

See https://packaging.python.org/tutorials/packaging-projects/ for more information.

Support the Project

There are many ways to contribute to the project:

• ⭐️ us on GitHub.
• Help us test the application.
• Spread the word about WebODM on social media.
• Become a contributor!