Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.35 KB

README-dev.md

File metadata and controls

59 lines (38 loc) · 1.35 KB
Raw

UP42 SDK Developer Readme

Installation

The development installation is necessary if you want to contribute to up42-py, e.g. to fix a bug.

  1. Optional (but highly recommended): Create a new virtual environment e.g. using virtualenvwrapper:
mkvirtualenv --python=$(which python3.7) up42-py
  1. Clone the repository and install locally with SystemLink (code changes are reflected). This will install all the neccessary dependencies for up42-py, running the tests and editing the docs.
git clone [email protected]:up42/up42-py.git
cd up42-py
poetry install
unlink $(PWD)/docs/examples; ln -s $(PWD)/examples docs

  1. Authenticate.

  2. Test it in Python.

up42.initialize_asset(asset_id="your-asset-id")

Edit the docs

The up42-py documentation is based on markdown and build with MkDocs & Material for MkDocs.

In order to live-preview your changes for easier editing, run the MkDocs preview in the main folder:

cd up42-py
mkdocs serve

In the browser, open:

http://127.0.0.1:8000

Edit the markdown files in up42-py/docs. Save them to see the changes reflected in the preview.

Run the tests

In the main folder up42-py, run:

make test