brvstr
Developer Guide
Setup
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n brvstr --file env.yml
Install
pip install -e .
# install from pypi
pip install brvstr
nbdev
# activate conda environment
$ conda activate brvstr
# make sure the brvstr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the brvstr package
$ nbdev_prepare
Publishing
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
Usage
Installation
Install latest from the GitHub repository:
$ pip install git+https://github.com/dsm-72/brvstr.git
or from conda
$ conda install -c dsm-72 brvstr
or from pypi
$ pip install brvstr
Documentation
Documentation can be found hosted on GitHub repository pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.
# Example usage
kg_low = brvstr('kilogram', 'kg')
kg_cap = brvstr('Kilogram', 'Kg')
kg_upp = brvstr('KILOGRAM', 'KG')
kg_low, kg_cap, kg_upp
(kilogram (kg), Kilogram (Kg), KILOGRAM (KG))
kg_low == kg_cap == kg_upp
True
no_abrv = brvstr('Kilogram', )
no_abrv == 'kilogram', no_abrv
(True, Kilogram)
Metadata
Release files for brvstr 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| brvstr-0.0.1.tar.gz | 10.2 kB | Without provenance | Details for brvstr-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| brvstr-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for brvstr-0.0.1-py3-none-any.whl |
Total release size: 19.9 kB
Release files / brvstr-0.0.1.tar.gz
| Download URL | brvstr-0.0.1.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b8d2f6dfe52a9ddf44dcb11e67072e4dafb310e763d42b638609ad2536af2c4
|
|
BLAKE2b-256 checksum How to use checksums |
59c7e45badd0bbcc145c845c3f571f7cb1246f29591fd9e5c3eac2b26d5e3d32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / brvstr-0.0.1-py3-none-any.whl
| Download URL | brvstr-0.0.1-py3-none-any.whl |
|---|---|
| Size | 9.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aa8292711de29d0b2c102998eefc355f902db6b515d0f1014f68f510914691d1
|
|
BLAKE2b-256 checksum How to use checksums |
314ba2c90b04f5ce23034432be94f875eb8a9964f40c761e16aa29b9e2655e11
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for brvstr 0.0.1
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.