wwtp-configuration


Namewwtp-configuration JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://github.com/we3lab/wwtp-configuration
SummaryClass hierarchy to represent a wastewater treatment plant's configuration.
upload_time2023-07-26 00:55:03
maintainer
docs_urlNone
authorWE3 Lab
requires_python>=3.9
license
keywords wwtp-configuration
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ******************
WWTP Configuration
******************

.. image::
   https://github.com/we3lab/wwtp-configuration/workflows/Build%20Main/badge.svg
   :height: 30
   :target: https://github.com/we3lab/wwtp-configuration/actions
   :alt: Build Status

.. image::
   https://github.com/we3lab/wwtp-configuration/workflows/Documentation/badge.svg
   :height: 30
   :target: https://we3lab.github.io/wwtp-configuration
   :alt: Documentation

.. image::
   https://codecov.io/gh/we3lab/wwtp-configuration/branch/main/graph/badge.svg
   :height: 30
   :target: https://codecov.io/gh/we3lab/wwtp-configuration
   :alt: Code Coverage

A class hierarchy designed to represent a wastewater treatment plant's configuration.

Useful Commands
===============

1. ``pip install -e .``

  This will install your package in editable mode.

2. ``pytest wwtp_configuration/tests --cov=wwtp_configuration --cov-report=html``

  Produces an HTML test coverage report for the entire project which can
  be found at ``htmlcov/index.html``.

3. ``docs/make html``

  This will generate an HTML version of the documentation which can be found
  at ``_build/html/index.html``.

4. ``flake8 wwtp_configuration --count --verbose --show-source --statistics``

  This will lint the code and share all the style errors it finds.

5. ``black wwtp_configuration``

  This will reformat the code according to strict style guidelines.

Legal Documents
===============

- `LICENSE <https://github.com/we3lab/wwtp-configuration/blob/main/LICENSE/>`_
- `CONTRIBUTING <https://github.com/we3lab/wwtp-configuration/blob/main/CONTRIBUTING.rst/>`_



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/we3lab/wwtp-configuration",
    "name": "wwtp-configuration",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "wwtp-configuration",
    "author": "WE3 Lab",
    "author_email": "fchapin@stanford.edu",
    "download_url": "https://files.pythonhosted.org/packages/7e/77/af4b1623886328a52fad9e4bd3fa0ac184692c6059727336aa91c31235cd/wwtp-configuration-0.3.1.tar.gz",
    "platform": null,
    "description": "******************\nWWTP Configuration\n******************\n\n.. image::\n   https://github.com/we3lab/wwtp-configuration/workflows/Build%20Main/badge.svg\n   :height: 30\n   :target: https://github.com/we3lab/wwtp-configuration/actions\n   :alt: Build Status\n\n.. image::\n   https://github.com/we3lab/wwtp-configuration/workflows/Documentation/badge.svg\n   :height: 30\n   :target: https://we3lab.github.io/wwtp-configuration\n   :alt: Documentation\n\n.. image::\n   https://codecov.io/gh/we3lab/wwtp-configuration/branch/main/graph/badge.svg\n   :height: 30\n   :target: https://codecov.io/gh/we3lab/wwtp-configuration\n   :alt: Code Coverage\n\nA class hierarchy designed to represent a wastewater treatment plant's configuration.\n\nUseful Commands\n===============\n\n1. ``pip install -e .``\n\n  This will install your package in editable mode.\n\n2. ``pytest wwtp_configuration/tests --cov=wwtp_configuration --cov-report=html``\n\n  Produces an HTML test coverage report for the entire project which can\n  be found at ``htmlcov/index.html``.\n\n3. ``docs/make html``\n\n  This will generate an HTML version of the documentation which can be found\n  at ``_build/html/index.html``.\n\n4. ``flake8 wwtp_configuration --count --verbose --show-source --statistics``\n\n  This will lint the code and share all the style errors it finds.\n\n5. ``black wwtp_configuration``\n\n  This will reformat the code according to strict style guidelines.\n\nLegal Documents\n===============\n\n- `LICENSE <https://github.com/we3lab/wwtp-configuration/blob/main/LICENSE/>`_\n- `CONTRIBUTING <https://github.com/we3lab/wwtp-configuration/blob/main/CONTRIBUTING.rst/>`_\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Class hierarchy to represent a wastewater treatment plant's configuration.",
    "version": "0.3.1",
    "project_urls": {
        "Homepage": "https://github.com/we3lab/wwtp-configuration"
    },
    "split_keywords": [
        "wwtp-configuration"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6af9a5030a021392fb7411c84d7f41f90822df853e230c55f36af72018a309f2",
                "md5": "11e21c8ea663e51ca83b8ca63fb0b0e0",
                "sha256": "0572ed7fea5f9a7daebd32608c544750ca8d3ad46df5320f90305f4ac7604db4"
            },
            "downloads": -1,
            "filename": "wwtp_configuration-0.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11e21c8ea663e51ca83b8ca63fb0b0e0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9",
            "size": 47566,
            "upload_time": "2023-07-26T00:55:02",
            "upload_time_iso_8601": "2023-07-26T00:55:02.217775Z",
            "url": "https://files.pythonhosted.org/packages/6a/f9/a5030a021392fb7411c84d7f41f90822df853e230c55f36af72018a309f2/wwtp_configuration-0.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e77af4b1623886328a52fad9e4bd3fa0ac184692c6059727336aa91c31235cd",
                "md5": "0c198b8bfabc8aff33a6d443648c4a4a",
                "sha256": "d67a53e3833884114a924b69820c54827ab377f6054448de3c6799dac017cfaa"
            },
            "downloads": -1,
            "filename": "wwtp-configuration-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0c198b8bfabc8aff33a6d443648c4a4a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 50828,
            "upload_time": "2023-07-26T00:55:03",
            "upload_time_iso_8601": "2023-07-26T00:55:03.451461Z",
            "url": "https://files.pythonhosted.org/packages/7e/77/af4b1623886328a52fad9e4bd3fa0ac184692c6059727336aa91c31235cd/wwtp-configuration-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-26 00:55:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "we3lab",
    "github_project": "wwtp-configuration",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "wwtp-configuration"
}
        
Elapsed time: 0.14337s