Skip to main content

Domino Data API for interacting with Domino Data features

Project description

Domino Data API

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License

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-codestyle uses isort, black and darglint library

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

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 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template

Project details


Release history Release notifications | RSS feed

This version

0.5.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dominodatalab_data-0.5.0.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

dominodatalab_data-0.5.0-py3-none-any.whl (62.2 kB view details)

Uploaded Python 3

File details

Details for the file dominodatalab_data-0.5.0.tar.gz.

File metadata

  • Download URL: dominodatalab_data-0.5.0.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.13 Darwin/21.6.0

File hashes

Hashes for dominodatalab_data-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9191ada5ca9f6610c0c4af592fe01f41c20fbc96443a34af58ec91f356af03c3
MD5 86fadcf97d8e4bfc021d3c528996aefc
BLAKE2b-256 5b84e16459fa212f51e124a9887b349dda592c89d16894508d78e9ea917bcfdf

See more details on using hashes here.

Provenance

File details

Details for the file dominodatalab_data-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dominodatalab_data-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9265b912476f3b62d4a5238f69f390dbe3898b203c9142143d9d60d4cc09caaa
MD5 33e711441b6f421a16a3b3736eb26195
BLAKE2b-256 ee6a1d9d1e5e190779d4e2140ee63e0465865ffd05ceca3a6e0bc699c0b19769

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page