# pfmt
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n pfmt --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install pfmt
```
### nbdev
``` sh
# activate conda environment
$ conda activate pfmt
# make sure the pfmt package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the pfmt package
$ nbdev_prepare
```
### Publishing
``` sh
# 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](https://github.com/dsm-72/pfmt):
``` sh
$ pip install git+https://github.com/dsm-72/pfmt.git
```
or from [conda](https://anaconda.org/dsm-72/pfmt)
``` sh
$ conda install -c dsm-72 pfmt
```
or from [pypi](https://pypi.org/project/pfmt/)
``` sh
$ pip install pfmt
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/pfmt)
[pages](https://dsm-72.github.io/pfmt/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/pfmt) and
[pypi](https://pypi.org/project/pfmt/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/pfmt",
"name": "pfmt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "power format formatter pfmt",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/1e/df/03cafd6486a4c17596d98f1539c9cf41c435b0ad65bc313ce6b59302d67e/pfmt-0.0.4.tar.gz",
"platform": null,
"description": "# pfmt\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n pfmt --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install pfmt\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate pfmt\n\n# make sure the pfmt package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the pfmt package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/pfmt):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/pfmt.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/pfmt)\n\n``` sh\n$ conda install -c dsm-72 pfmt\n```\n\nor from [pypi](https://pypi.org/project/pfmt/)\n\n``` sh\n$ pip install pfmt\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/pfmt)\n[pages](https://dsm-72.github.io/pfmt/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/pfmt) and\n[pypi](https://pypi.org/project/pfmt/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "pfmt",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/dsm-72/pfmt"
},
"split_keywords": [
"power",
"format",
"formatter",
"pfmt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b9b942a3b30216fc37a81e0238f9a05f0977bb3c859088f540e9bf7ae8e1ac0",
"md5": "d6785718ac0d93407ff081e16a0da647",
"sha256": "32873124124f4a86ea79a66547ccd329831b8acf4641d71ea95e4ff39d082392"
},
"downloads": -1,
"filename": "pfmt-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6785718ac0d93407ff081e16a0da647",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11009,
"upload_time": "2023-10-30T13:00:26",
"upload_time_iso_8601": "2023-10-30T13:00:26.595220Z",
"url": "https://files.pythonhosted.org/packages/1b/9b/942a3b30216fc37a81e0238f9a05f0977bb3c859088f540e9bf7ae8e1ac0/pfmt-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1edf03cafd6486a4c17596d98f1539c9cf41c435b0ad65bc313ce6b59302d67e",
"md5": "1cc4a91dc3ff38712c13926d84cfb2f2",
"sha256": "11a78e8912ae8995d864a3ff49a87357e78f94418e5c33633d0e17ef8a22e19c"
},
"downloads": -1,
"filename": "pfmt-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "1cc4a91dc3ff38712c13926d84cfb2f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10415,
"upload_time": "2023-10-30T13:00:27",
"upload_time_iso_8601": "2023-10-30T13:00:27.957861Z",
"url": "https://files.pythonhosted.org/packages/1e/df/03cafd6486a4c17596d98f1539c9cf41c435b0ad65bc313ce6b59302d67e/pfmt-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 13:00:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "pfmt",
"github_not_found": true,
"lcname": "pfmt"
}
JSON
