Skip to main content

github latest release pypi latest package docker latest image project license

nwa CI nwa CD security scan pre-commit

code coverage code alerts code quality code style

nwa

nwa: A collection of network analyses

Contents

  1. Use Case
  2. Configuration
  3. Development
  4. Testing
  5. Versioning
  6. Deployment
  7. Production

Use Case

A collection of network analyses implementations.
Input: [TODO].
Output: [TODO].

Requirements

  • [TODO]

Assumptions

  • [TODO]

Design

[TODO]

Configuration

Behaviour of the application can be configured via Environment Variables.

Environment Variable Description Type Default Value
NWA_LOG_LEVEL Level of logging - overrides verbose/quiet flag string -
NWA_LOG_DIR Directory to save logs string -
NWA_BIN_DIR Directory to save any output (bin) string bin

Development

Configure for local development

  • Clone repo on your local machine
  • Install conda or miniconda
  • Create your local project environment (based on conda, poetry, pre-commit):
    $ make env
  • (Optional) Update existing local project environment:
    $ make env-update

Run locally

On a terminal, run the following (execute on project's root directory):

  • Activate project environment:
    $ . ./scripts/helpers/environment.sh
  • Run the CLI using poetry:
    $ poetry run nwa

Contribute

[ Not Available ]

Testing

(part of CI/CD)

[ Work in progress... ]

To run the tests, open a terminal and run the following (execute on project's root directory):

  • Activate project environment:
    $ . ./scripts/helpers/environment.sh
  • To run pytest:
    $ make test
  • To check test coverage:
    $ make test-coverage

Versioning

Increment the version number:
$ poetry version {bump rule}
where valid bump rules are:

  1. patch
  2. minor
  3. major
  4. prepatch
  5. preminor
  6. premajor
  7. prerelease

Changelog

Use CHANGELOG.md to track the evolution of this package.
The [UNRELEASED] tag at the top of the file should always be there to log the work until a release occurs.

Work should be logged under one of the following subtitles:

  • Added
  • Changed
  • Fixed
  • Removed

On a release, a version of the following format should be added to all the current unreleased changes in the file.
## [major.minor.patch] - YYYY-MM-DD

Deployment

Pip package

On a terminal, run the following (execute on project's root directory):

  • Activate project environment:
    $ . ./scripts/helpers/environment.sh
  • To build pip package:
    $ make build-package
  • To publish pip package (requires credentials to PyPi):
    $ make publish-package

Docker image

On a terminal, run the following (execute on project's root directory):

  • Activate project environment:
    $ . ./scripts/helpers/environment.sh
  • To build docker image:
    $ make build-docker

Production

For production, a Docker image is used. This image is published publicly on docker hub.

  • First pull image from docker hub:
    $ docker pull nichelia/nwa:[version]
  • First pull image from docker hub:
    $ docker run --rm -it -v ~/nwa_bin:/usr/src/bin nichelia/nwa:[version]
    This command mounts the application's bin (outcome) to user's root directory under nwa_bin folder.

where version is the published application version (e.g. 0.1.0)

Metadata

Release files for nwa 0.0.1

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

Source distribution (sdist)

Source distribution for nwa 0.0.1
File Size Uploaded Provenance Actions
nwa-0.0.1.tar.gz 10.4 kB Without provenance Details for nwa-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nwa 0.0.1
File Interpreter ABI Platform Actions
nwa-0.0.1-py3-none-any.whl Python 3 none any Details for nwa-0.0.1-py3-none-any.whl

Total release size: 23.6 kB

Release files / nwa-0.0.1.tar.gz

Download URL nwa-0.0.1.tar.gz
Size 10.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3b434f65eff92319f30b350968a8f3aa895d0f207070080824287287d54308aa
BLAKE2b-256 checksum
How to use checksums
31cbf9283c90ab35f7095d791e58810c00c6a82d25df86cf6ec399fe56a54cfa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.0 CPython/3.8.2 Linux/5.3.0-1022-azure

Release files / nwa-0.0.1-py3-none-any.whl

Download URL nwa-0.0.1-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e4e45359bc49bf991e72e5edadc722dabe7dd21ced6eb175abea592d713faf3
BLAKE2b-256 checksum
How to use checksums
a98e7bd55e74894b11ed69eb2cca90bff54a2f61295d0738426b03926b1825d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.0 CPython/3.8.2 Linux/5.3.0-1022-azure

Security for nwa 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.

Release history Release notifications | RSS feed

This release

0.0.1 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