This release is a pre-release and may not be stable for production use.
opendors
Construct and interact with OpenDORS datasets.
[!important]
opendorsis work in progress. Prior to major version 1, it may not be complete, usable, reliable or well-engineered.
Installation
Install directly from PyPI: pip install opendors.
Install from source (requires Poetry):
# Clone git repository & change into clone directory
git clone git@gitlab.dlr.de:drus_st/opendorslib.git
cd opendorslib
# Install with poetry
poetry install
If you want to use the repository workflow rule,
you also need to install Ruby with the github-linguist and licensee gems.
This repository contains a definition for a conda environment that you can use to install these extra dependencies:
conda-environment.yml.
To install the dependencies, do:
mamba env create -n opendors --file conda-environment.yml
mamba activate opendors
gem install github-linguist
gem install licensee
Keep the environment activated to use the repository rule.
Usage
opendors provides both an API for creating an OpenDORS dataset,
and a CLI tool to interact with an OpenDORS dataset.
usage: opendors [-h] [-c] [-v] {schema,filter,stats,merge} ...
Utilities to work with OpenDORS datasets.
positional arguments:
{schema,filter,stats,merge}
Available commands
schema Exports the JSON schema for the opendors model to 'schema.json'.
filter Filters a given dataset by programming language and/or before/after dates.
stats Gather statistics on a given OpenDORS dataset.
merge Merge OpenDORS datasets into a single file.
options:
-h, --help show this help message and exit
-c, --compressed Export as unindented JSON
-v, --verbose Print tracebacks on error
Build Python package
Run poetry build.
To publish to PyPI, run poetry publish.
You need to have a PyPI API token configured to do this.
Run tests
Tests can be run locally as follows:
poetry run pytest tests/
Test coverage
Coverage (with branch coverage) can be displayed as follows:
poetry run python -m pytest tests --cov=opendors --cov-branch --cov-report=html --cov-report=term
1 maintainer
Metadata
1 maintainer
Release files for opendors 0.1.dev22
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| opendors-0.1.dev22.tar.gz | 55.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| opendors-0.1.dev22-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 118.9 kB
Release files / opendors-0.1.dev22.tar.gz
| Download URL | opendors-0.1.dev22.tar.gz |
|---|---|
| Size | 55.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
503c10dac67c787527b853bf1231b11df9f7419e6239fe1674ab748ccc50edaa
|
|
BLAKE2b-256 checksum How to use checksums |
dbc0e917f124dcde4a97db834f0fa6b9acff270937c4d0b29a915789f3ba8d14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.3 Linux/5.15.153.1-microsoft-standard-WSL2
|
Release files / opendors-0.1.dev22-py3-none-any.whl
| Download URL | opendors-0.1.dev22-py3-none-any.whl |
|---|---|
| Size | 63.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3f25ff5981a097e4a101a329a78c7fe4a27c48891225bf3865d4ed59756f714b
|
|
BLAKE2b-256 checksum How to use checksums |
dd8b1f5a97a5123702caec514be08a4bd9293f7980049133f45c93d7e0e0b3ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.12.3 Linux/5.15.153.1-microsoft-standard-WSL2
|
