Note
This Document2.0 formatted README.md file was provided by dannywoof, the maintainer of this library. If you have any questions or feedback, feel free to reach out via bluesky or email.
Nitrogen
Installation
pip install wwn
Dependencies
- Python 3.12+
Commands
General
General commands for installing and managing Wednesware publications and packages.
get <publication> [release]
Download a Wednesware publication from GitHub. Publication names can also be written as their chemical symbols, e.g. mg for Magnesium, he for Helium. If no release is specified, the latest release will be downloaded.
n2 get magnesium 26.5
rm <publication> [release]
Delete one release or all installed releases for a publication. If no release is specified, all installed releases will be deleted.
n2 rm magnesium 26.5
install <path> [--name <command>] [--bin <dir>] [--no-deps]
Install a Nitrogen package from a local directory.
n2 install ./my_package --name my_command --bin ./bin --no-deps
install-cache <publication> [release] [--name <command>] [--bin <dir>]
Install a cached publication from Nitrogen's internal cache as a command without re-downloading.
n2 install-cache magnesium 26.5 --name mg --bin ./bin
list
List installed publications in Nitrogen's internal cache.
n2 list
cache
Show the total cache size and per-publication cache usage for the internal cache directory.
n2 cache
uninstall <command> [--bin <dir>]
Uninstall a Nitrogen package by its command name. If the --bin option is not specified, the default bin directory will be used.
n2 uninstall my_command --bin ./bin
Documentation
Read documentation bundled with Nitrogen.
readme
Show the Nitrogen README.
n2 readme
license
Show the Nitrogen license.
n2 license
help
Show the full help message with all commands.
n2 help
Definitions
nitrogen
Nitrogen can be used as a Python library. You may use any internal functions, but there are also functions specifically meant for use via the library.
nitrogen:require(pub: str, rel: str | None = None) -> object
Load a Wednesware publication from Nitrogen's internal cache. The first run may need internet access to download the publication, but later runs reuse the cached copy locally. Submodules should be provided within the pub parameter like magnesium.color. Chemical symbols can also be used for publication names, e.g. mg for Magnesium, he for Helium.
Color = require("magnesium.color", "26.5").Color
nitrogen:NitrogenDependencyError
Raised when a dependency is not already cached locally and the source site cannot be reached or is otherwise unavailable.
nitrogen:cleanup() -> None
Clean up the internal cache directory by removing any unused publications. This is useful for freeing up disk space after installing and using publications. Generally makes programs significantly slower if you use require.
cleanup()
nitrogen:entrypoint() -> None
Starts Nitrogen.
entrypoint()
1 maintainer
Release files for wwn 26.61
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wwn-26.61.tar.gz | 15.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wwn-26.61-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.7 kB
Release files / wwn-26.61.tar.gz
| Download URL | wwn-26.61.tar.gz |
|---|---|
| Size | 15.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
828ef024059264c477caad89570e4a89521aee1adaad5f6b3cbf1ff716f98ffd
|
|
BLAKE2b-256 checksum How to use checksums |
ee561a50ce537357e011a75d1563296941355edfc8b25a45608c644a7a97d45e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / wwn-26.61-py3-none-any.whl
| Download URL | wwn-26.61-py3-none-any.whl |
|---|---|
| Size | 12.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d3e95e41571115ad6f5466809e8fd75f128ac888a20d10b2f2037d6b7323d592
|
|
BLAKE2b-256 checksum How to use checksums |
759fe253808c253a38e57d505160ba7d70a145f0bf7997cf32a7eecf0b1c0bbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
