Receptorctl is a front-end CLI and importable Python library that interacts with Receptor over its control socket interface.
Project description
Receptorctl
Receptorctl is a front-end CLI and importable Python library that interacts with Receptor over its control socket interface.
Setting up nox
This project includes a nox
configuration to automate tests, checks, and other functions in a reproducible way using isolated environments.
Before you submit a PR, you should install nox
and verify your changes.
To run
make receptorctl-lint
andreceptorctl-test
from the repository root, you must first installnox
.
- Install
nox
usingpython3 -m pip install nox
or your distribution's package manager. - Run
nox --list
from thereceptorctl
directory to view available sessions.
You can run nox
with no arguments to execute all checks and tests.
Alternatively, you can run only certain tasks as outlined in the following sections.
By default nox sessions install pinned dependencies from
pyproject.toml
.
Checking changes to Receptorctl
Run the following nox
sessions to check for code style and formatting issues:
-
Run all checks.
nox -s lint
-
Check code style.
nox -s check_style
-
Check formatting.
nox -s check_format
-
Format code if the check fails.
nox -s format
Running Receptorctl tests
Run the following nox
sessions to test Receptorctl changes:
-
Run tests against the complete matrix of Python versions.
nox -s tests
-
Run tests against a specific Python version.
# For example, this command tests Receptorctl against Python 3.12. nox -s tests-3.12
Updating dependencies
Update dependencies in the requirements
directory as follows:
- Add any packages or pins to the
*.in
file. - Do one of the following from the
receptorctl
directory:
-
Update all dependencies.
nox -s pip-compile
-
Generate the full dependency tree for a single set of dependencies, for example:
nox -s "pip-compile-3.12(tests)"
You can also pass the
--no-upgrade
flag when adding a new package. This avoids bumping transitive dependencies for other packages in the*.in
file.
nox -s pip-compile -- --no-upgrade
Project details
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
File details
Details for the file receptorctl-1.5.7.tar.gz
.
File metadata
- Download URL: receptorctl-1.5.7.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
1da665a3edd35d4e1c7a58d1db6c5da824f45fee59c0743c006f1b9c79d33389
|
|
MD5 |
6a574f110c73e3a041dbfd1f1f26ff5b
|
|
BLAKE2b-256 |
5c6a7dec78bafc851448baae5b652b2f236110e19f7d0524662d28ffbe9efc45
|
File details
Details for the file receptorctl-1.5.7-py3-none-any.whl
.
File metadata
- Download URL: receptorctl-1.5.7-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
da01ac6a11622889a3eece90da3344b29f9a9a1dbe8c2b0373e921c60d6d0a70
|
|
MD5 |
9dd29dd6c7a65d637d88b11742ac2bcd
|
|
BLAKE2b-256 |
5e5db12a01b5361819aa87f44dbbcf1ca3824c17ab71d9ec87dbf23f0922b819
|