Developer utilities to help manage nubium applications and other typical maintenance tasks
Project description
dude CLI
Installation and Setup
pipx install dude
Further setup
In order to use dude
, you will need to set a few things up.
Environment Variables and Configuration
dude
can largely be configured via a config.env
file, an example of which
can be found at ./dude/config.env
(which is also used by default if one not provided. It
will basically set any possible working defaults). Simply set the path of:
DUDE_CONFIG_DOTENV
Additionally, you'll likely need to set, at minimum:
DUDE_CREDENTIALS_DOTENV
={path to a .env with various credentials}
NOTE: this will likely change in the future and secrets will be downloaded by default for you.
Lastly, there are (new) variables related to nubium-utils
; these can just go in your dude
creds.env file:
RHOSAK_USERNAME=(same as preprod)
RHOSAK_PASSWORD=(same as preprod)
TEST_CLUSTER=(ask Tim)
Usage
examples of common tasks
-
Create topics:
dude topics create topic_a,topic_b
-
Build requirements.txt:
(in app root folder):
dude app build_reqs
-
Run app:
(in app root folder):
dude app run
Known limitations:
-
Currently, no proper error handling if topics already exist (create) or are missing (delete); you will need to validate whether your topics exist else it will fail.
-
Test coverage is almost non-existent.
Development
There's two ways to develop:
option 1
if you only need to make changes to dude
, the easiest thing to do is just install an
editable version of the library:
pipx install -e /PATH/TO/DUDE/REPO
option 2
Another option more suitable for coordinating changes that involve multiple nubium libraries is instead making a new venv, sourcing it, and then:
pip install -e /PATH/TO/DUDE/REPO
then you can install -e
versions of all the nubium-{}
packages. You'll of course need to
source this environment when you test.
once we finish adding more tests...
Run tests via
pipx install tox
tox && tox -e cov
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
Hashes for nubium_dude-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f62aa3b4651f1d0afc1bb39683f3db314ae10836e305d0523d03b46d3bcf3619 |
|
MD5 | 62a4c645793821d7b2a80fd6d5da0a94 |
|
BLAKE2b-256 | d3530b603270c48252e9d766c6f96d94eed24c91cfd40eb9e263de4b7cd7f4b5 |