Skip to main content

redis-bandit

Build status Python Version Dependencies Status

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

A Python, redis-backed, distributed Multi-Armed Bandit Framework. The goal is being able to scale a MAB horizontally.

Installation

pip install -U redis-bandit

or install with Poetry

poetry add redis-bandit

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, 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{redis-bandit,
  author = {fernandocamargoai},
  title = {A Python, redis-backed, distributed Multi-Armed Bandit Framework. The goal is being able to scale a MAB horizontally.},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/deeplearningbrasil/redis-bandit}}
}

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

This project was generated with python-package-template

Metadata

Release files for redis-bandit 0.1.0

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

Source distribution (sdist)

Source distribution for redis-bandit 0.1.0
File Size Uploaded Provenance Actions
redis-bandit-0.1.0.tar.gz 12.3 kB Without provenance Details for redis-bandit-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for redis-bandit 0.1.0
File Interpreter ABI Platform Actions
redis_bandit-0.1.0-py3-none-any.whl Python 3 none any Details for redis_bandit-0.1.0-py3-none-any.whl

Total release size: 23.5 kB

Release files / redis-bandit-0.1.0.tar.gz

Download URL redis-bandit-0.1.0.tar.gz
Size 12.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d837810bbe418161898baa4353e3298202e648fab52a0fa107b0abcba82ec9c3
BLAKE2b-256 checksum
How to use checksums
41a11324de4c0959e4eea0a3448b16de3eb2ff6244a14c25d4541752cb7c3649
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.7.12 Linux/5.8.0-1042-azure

Release files / redis_bandit-0.1.0-py3-none-any.whl

Download URL redis_bandit-0.1.0-py3-none-any.whl
Size 11.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f89e2927c96cfb430e5a09853901c80ab229e04266c78797bfa14fb04ca58c01
BLAKE2b-256 checksum
How to use checksums
46184deae366dc7dcbab49fbb9e113c473a3aa41064448b8de8cf07f3057b0ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.7.12 Linux/5.8.0-1042-azure

Security for redis-bandit 0.1.0

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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

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