# Installation
`pip install nemo_reporting_core`
# Helloworld
- `from nemo_reporting_core.welcome import say_hello`
- `say_hello()`
- `say_hello("Everybody")`
# setup.py
`setup.py` is the build script for setuptools. It tells setuptools about your package (such as the name and version) as well as which code files to include. Some important entries and examples are shown below.
* name=<package name> e.g. ga-reporting-etls
* description=<>
* packages=<folder name> e.g. testpypi
* version=<auto generated by bump version>
* setup_requires=['pytest-runner']
* tests_require=['pytest','pylint']
# setup.cfg
setup.cfg is the configuration file for setuptools. It tells setuptools about your package (such as the name and version) as well as which code files to include. We will have pytest and pylint as bare minimum in the cfg file but more can be added specific to the package
# bumpversion (.bumpversion.cfg)
bumpversion is used to bump major,minor and patch versions. `https://pypi.org/project/bumpversion/`
Command: bumpversion minor|major|patch --allow-dirty
# Migrations
Make sure the following environment variables are set before running Alembic commands. This needs to be a suitably privileged user.
```
DB_HOST
DB_USER
DB_PASSWORD
DB_NAME (optional)
DB_PORT (optional)
```
### Upgrade Workflow
- `alembic revision --autogenerate -m <MESSAGE>`
- Check the file manually!!!
- `alembic upgrade head --sql` to view the DDL generated
- `alembic upgrade head` to appply directly to database
- command `apply-migrations` can be used anywhere the package is installed
Raw data
{
"_id": null,
"home_page": "http://www.ga.gov.au/",
"name": "nemo-reporting-core",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "NEMO Operations",
"author_email": "ramkumar.ramagopalan@ga.gov.au",
"download_url": "",
"platform": null,
"description": "# Installation\n\n`pip install nemo_reporting_core`\n\n# Helloworld\n\n - `from nemo_reporting_core.welcome import say_hello`\n - `say_hello()`\n - `say_hello(\"Everybody\")`\n\n# setup.py\n`setup.py` is the build script for setuptools. It tells setuptools about your package (such as the name and version) as well as which code files to include. Some important entries and examples are shown below.\n\n * name=<package name> e.g. ga-reporting-etls\n * description=<>\n * packages=<folder name> e.g. testpypi\n * version=<auto generated by bump version>\n * setup_requires=['pytest-runner']\n * tests_require=['pytest','pylint']\n\n# setup.cfg\nsetup.cfg is the configuration file for setuptools. It tells setuptools about your package (such as the name and version) as well as which code files to include. We will have pytest and pylint as bare minimum in the cfg file but more can be added specific to the package\n\n\n# bumpversion (.bumpversion.cfg)\nbumpversion is used to bump major,minor and patch versions. `https://pypi.org/project/bumpversion/`\nCommand: bumpversion minor|major|patch --allow-dirty\n\n# Migrations\n\nMake sure the following environment variables are set before running Alembic commands. This needs to be a suitably privileged user.\n\n```\nDB_HOST\nDB_USER\nDB_PASSWORD\nDB_NAME (optional)\nDB_PORT (optional)\n```\n\n### Upgrade Workflow\n\n - `alembic revision --autogenerate -m <MESSAGE>`\n - Check the file manually!!!\n - `alembic upgrade head --sql` to view the DDL generated \n - `alembic upgrade head` to appply directly to database\n - command `apply-migrations` can be used anywhere the package is installed\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Geoscience Australia - NEMO Automated Reporting Core",
"version": "0.8.7",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "137428f6f59f75061aa71f88ec91ca89",
"sha256": "a556aa16bbea9c37c5b78fea71f00b5eef73f298dcd2a1cd777c3c0072ad0271"
},
"downloads": -1,
"filename": "nemo_reporting_core-0.8.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "137428f6f59f75061aa71f88ec91ca89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18780,
"upload_time": "2022-06-23T03:31:30",
"upload_time_iso_8601": "2022-06-23T03:31:30.578324Z",
"url": "https://files.pythonhosted.org/packages/8a/bb/5a697b6eed7ff9e5170736b3f9a8c97116a40ce132bdd0e839c6bcb92488/nemo_reporting_core-0.8.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-23 03:31:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "nemo-reporting-core"
}
JSON