Domino Data API for interacting with Domino Data features
Project description
Domino Data API
Domino Data API for interacting with Access Data features
Installation
pip install -U dominodatalab-data
or install with Poetry
poetry add dominodatalab-data
Makefile usage
Makefile contains a lot of functions for faster development.
1. Download and remove Poetry
To download and install Poetry run:
make poetry-download
To uninstall
make poetry-remove
2. Install all dependencies and pre-commit hooks
Install requirements:
make install
Pre-commit hooks coulb be installed after git init via
make pre-commit-install
3. Codestyle
Automatic formatting uses pyupgrade, isort and black.
make codestyle
# or use synonym
make formatting
Codestyle checks only, without rewriting files:
make check-codestyle
Note:
check-codestyleusesisort,blackanddarglintlibrary
4. Code security
make check-safety
This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.
make check-safety
5. Type checks
Run mypy static type checker
make mypy
6. Tests
Run pytest
make test
7. All linters
Of course there is a command to rule run all linters in one:
make lint
the same as:
make test && make check-codestyle && make mypy && make check-safety
8. Cleanup
Delete pycache files
make pycache-remove
Remove package build
make build-remove
Or to remove pycache and build:
make clean-all
9. Docs
Build the documentation
make docs
Open the docs index page
make open-docs
📈 Releases
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
List of labels and corresponding titles
| Label | Title in Releases |
|---|---|
enhancement, feature |
🚀 Features |
bug, refactoring, bugfix, fix |
🔧 Fixes & Refactoring |
build, ci, testing |
📦 Build System & CI/CD |
breaking |
💥 Breaking Changes |
documentation |
📝 Documentation |
dependencies |
⬆️ Dependencies updates |
You can update it in release-drafter.yml.
GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
🛡 License
This project is licensed under the terms of the Apache Software License 2.0 license. See LICENSE for more details.
📃 Citation
@misc{dominodatalab-data,
author = {dominodatalab},
title = {Domino Data API for interacting with Access Data features},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/dominodatalab/domino-data}}
}
Credits 
This project was generated with python-package-template
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dominodatalab-data-0.3.1.dev4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ebc9b30801ff9a42ed5f08c742d7566beab716bec5e828f9393958af688bfbc0 |
|
| MD5 | 416c3c2cc0f8fca36378b4511b052140 |
|
| BLAKE2b-256 | e04b531a5243531a21745bfa807248cf582ae47a02cbb62bb2efc862b8767139 |
Hashes for dominodatalab_data-0.3.1.dev4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4481b37a5c8b8360205151fae2e261975944540ccb9c8f19f531a3610f477954 |
|
| MD5 | a1faf9d8d8f96c122f62d754524bae81 |
|
| BLAKE2b-256 | b90025be3bb5e762f18d6a5c33c2c1f51375b2775c124efe4e51a6de0578b334 |
