| Name | odhpy JSON |
| Version |
0.2.9
JSON |
| download |
| home_page | https://bitbucket.org/odhydrology/odhpy.git |
| Summary | A collection of splashings to master that which has no form and count that which is uncountable. |
| upload_time | 2025-02-12 02:27:10 |
| maintainer | None |
| docs_url | None |
| author | Chas Egan |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# odhpy
## Installation
This package may be installed using pip from Bitbucket (requires authentication), or directly from PyPi (public), or from a .tar.gz. Examples are shown below.
```bash
pip install git+https://bitbucket.org/odhydrology/odhpy.git
```
```bash
pip install odhpy
```
```bash
pip install .\dist\odhpy-0.0.32.tar.gz
```
## Usage
```python
import odhpy
# returns the package version
odhpy.__version__
# prints 'Hello world!' to the console
odhpy.hello_world()
```
## Build and Upload to PyPi
First build a distribution from an anaconda prompt in the root of your project, and then upload the dist to PyPi using Twine.
```bash
python setup.py sdist
```
```bash
twine upload dist\odhpy-0.0.32.tar.gz
```
As of Nov 2023, PyPi uses an API token instead of a conventional password. You can still use Twine, but the username is "__token__", and password is the API token which is very long string starting with "pypi-".
``` bash
username = __token__
password = pypi-#####################################################################################
```
Where can I find the API token password? Chas has it in his emails. It is also here on the network at *.\ODH working files\Professional development, reading, etc\Software\ODHSoftware\ODHPy\PyPi_password_and_instructions.txt*.
How do I make a new API token? Go to your PyPi account settings, and click on "API tokens". Then click on "Add API token", and give it a name. The token will be displayed on the next screen.
## Unit Tests
WARNING: Run unit tests from an anaconda environment with compatable dependencies!
Install the nose2 test-runner framework.
```bash
pip install nose2
```
Then from the root project folder run the nose2 module. You can do this as a python modules, or just direcly from the anaconda prompt (both examples given below). This will automatically find and run tests in any modules named "test_*".
```bash
python -m nose2
```
```bash
nose2
```
You can run specific tests by specifying the module name. Example below.
```bash
nose2 src.odhpy.stats.tests
```
## License
None.
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/odhydrology/odhpy.git",
"name": "odhpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Chas Egan",
"author_email": "chas@odhydrology.com",
"download_url": "https://files.pythonhosted.org/packages/4c/7b/87000edca85acf5aaf375f0cf7c18a73d7f6cefd14487bf3e337e953b904/odhpy-0.2.9.tar.gz",
"platform": null,
"description": "# odhpy\r\n\r\n## Installation\r\n\r\nThis package may be installed using pip from Bitbucket (requires authentication), or directly from PyPi (public), or from a .tar.gz. Examples are shown below.\r\n\r\n```bash\r\npip install git+https://bitbucket.org/odhydrology/odhpy.git\r\n```\r\n\r\n```bash\r\npip install odhpy\r\n```\r\n\r\n```bash\r\npip install .\\dist\\odhpy-0.0.32.tar.gz\r\n```\r\n\r\n## Usage\r\n\r\n```python\r\nimport odhpy\r\n\r\n# returns the package version\r\nodhpy.__version__\r\n\r\n# prints 'Hello world!' to the console\r\nodhpy.hello_world()\r\n```\r\n\r\n## Build and Upload to PyPi\r\n\r\nFirst build a distribution from an anaconda prompt in the root of your project, and then upload the dist to PyPi using Twine.\r\n\r\n```bash\r\npython setup.py sdist\r\n```\r\n\r\n```bash\r\ntwine upload dist\\odhpy-0.0.32.tar.gz\r\n```\r\n\r\nAs of Nov 2023, PyPi uses an API token instead of a conventional password. You can still use Twine, but the username is \"__token__\", and password is the API token which is very long string starting with \"pypi-\". \r\n\r\n``` bash\r\nusername = __token__\r\npassword = pypi-#####################################################################################\r\n```\r\n\r\nWhere can I find the API token password? Chas has it in his emails. It is also here on the network at *.\\ODH working files\\Professional development, reading, etc\\Software\\ODHSoftware\\ODHPy\\PyPi_password_and_instructions.txt*.\r\n\r\nHow do I make a new API token? Go to your PyPi account settings, and click on \"API tokens\". Then click on \"Add API token\", and give it a name. The token will be displayed on the next screen.\r\n\r\n## Unit Tests\r\n\r\nWARNING: Run unit tests from an anaconda environment with compatable dependencies!\r\n\r\nInstall the nose2 test-runner framework. \r\n\r\n```bash\r\npip install nose2\r\n```\r\n\r\nThen from the root project folder run the nose2 module. You can do this as a python modules, or just direcly from the anaconda prompt (both examples given below). This will automatically find and run tests in any modules named \"test_*\".\r\n\r\n```bash\r\npython -m nose2\r\n```\r\n\r\n```bash\r\nnose2\r\n```\r\n\r\nYou can run specific tests by specifying the module name. Example below.\r\n\r\n```bash\r\nnose2 src.odhpy.stats.tests\r\n```\r\n\r\n## License\r\n\r\nNone.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of splashings to master that which has no form and count that which is uncountable.",
"version": "0.2.9",
"project_urls": {
"Homepage": "https://bitbucket.org/odhydrology/odhpy.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c7b87000edca85acf5aaf375f0cf7c18a73d7f6cefd14487bf3e337e953b904",
"md5": "a262b768f7d0704ffa8f017ec361a385",
"sha256": "9c37964de388261dcfc55c84768d4e7bdfd0d6f590917a52966a055b6f5c4dda"
},
"downloads": -1,
"filename": "odhpy-0.2.9.tar.gz",
"has_sig": false,
"md5_digest": "a262b768f7d0704ffa8f017ec361a385",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 47388,
"upload_time": "2025-02-12T02:27:10",
"upload_time_iso_8601": "2025-02-12T02:27:10.350388Z",
"url": "https://files.pythonhosted.org/packages/4c/7b/87000edca85acf5aaf375f0cf7c18a73d7f6cefd14487bf3e337e953b904/odhpy-0.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 02:27:10",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "odhydrology",
"bitbucket_project": "odhpy",
"lcname": "odhpy"
}
