Skip to main content

bento2seldon4recsys

Build status Python Version Dependencies Status

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

Extension of bento2seldon for RecSys.

Installation

pip install -U bento2seldon4recsys

or install with Poetry

poetry add bento2seldon4recsys

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. Docker

make docker-build

which is equivalent to:

make docker-build VERSION=latest

Remove docker image with

make docker-remove

More information about docker.

9. Cleanup

Delete pycache files

make pycache-remove

Remove package build

make build-remove

Or to remove pycache, build and docker image run:

make clean-all

📈 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{bento2seldon4recsys,
  author = {deeplearningbrasil},
  title = {Extension of bento2seldon for RecSys.},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/deeplearningbrasil/bento2seldon4recsys}}
}

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template

Metadata

Release files for bento2seldon4recsys 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bento2seldon4recsys 0.1.3
File Size Uploaded Provenance Actions
bento2seldon4recsys-0.1.3.tar.gz 17.1 kB Without provenance Details for bento2seldon4recsys-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bento2seldon4recsys 0.1.3
File Interpreter ABI Platform Actions
bento2seldon4recsys-0.1.3-py3-none-any.whl Python 3 none any Details for bento2seldon4recsys-0.1.3-py3-none-any.whl

Total release size: 32.8 kB

Release files / bento2seldon4recsys-0.1.3.tar.gz

Download URL bento2seldon4recsys-0.1.3.tar.gz
Size 17.1 kB
Tags Source
SHA-256 checksum
How to use checksums
13205b3a539191936dab8dc235490a5599084b3033888d2189e54446ba03150f
BLAKE2b-256 checksum
How to use checksums
b61321b8a1473c62a58f7c7e701dceafb920ca818260436401868d6ed069124e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure

Release files / bento2seldon4recsys-0.1.3-py3-none-any.whl

Download URL bento2seldon4recsys-0.1.3-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
259cbff9c293f7b2c8ca135ed8b73ecac22dac708c099d6a97634e9430f14e39
BLAKE2b-256 checksum
How to use checksums
c6af0beb858a441370b13df6cfd4367843fcd09c02be9f53e87765bf8dce3761
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure

Security for bento2seldon4recsys 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page