# psrc
<!-- 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 psrc --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install psrc
```
### nbdev
``` sh
# activate conda environment
$ conda activate psrc
# make sure the psrc package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the psrc 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/psrc):
``` sh
$ pip install git+https://github.com/dsm-72/psrc.git
```
or from [conda](https://anaconda.org/dsm-72/psrc)
``` sh
$ conda install -c dsm-72 psrc
```
or from [pypi](https://pypi.org/project/psrc/)
``` sh
$ pip install psrc
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/psrc)
[pages](https://dsm-72.github.io/psrc/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/psrc) and
[pypi](https://pypi.org/project/psrc/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/psrc",
"name": "psrc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/29/82/02298f09f2bbf8bdb967903290beabd8d8dc206e1f39b08dcae80c264a82/psrc-0.0.18.tar.gz",
"platform": null,
"description": "# psrc\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 psrc --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install psrc\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate psrc\n\n# make sure the psrc 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 psrc 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/psrc):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/psrc.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/psrc)\n\n``` sh\n$ conda install -c dsm-72 psrc\n```\n\nor from [pypi](https://pypi.org/project/psrc/)\n\n``` sh\n$ pip install psrc\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/psrc)\n[pages](https://dsm-72.github.io/psrc/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/psrc) and\n[pypi](https://pypi.org/project/psrc/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "structured directories",
"version": "0.0.18",
"project_urls": {
"Homepage": "https://github.com/dsm-72/psrc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8f7957d345a749f2a8a174fc5e6962aaf31be85daaafb61bee9434441b1f158",
"md5": "7f31ca1b5dbe3cba43d767a3063ef3be",
"sha256": "6f09104d84052b5a9a0f1afcdae860922922d23c746b1aa9e7cf8aa22056e1e7"
},
"downloads": -1,
"filename": "psrc-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f31ca1b5dbe3cba43d767a3063ef3be",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 25148,
"upload_time": "2023-11-25T14:20:14",
"upload_time_iso_8601": "2023-11-25T14:20:14.880748Z",
"url": "https://files.pythonhosted.org/packages/b8/f7/957d345a749f2a8a174fc5e6962aaf31be85daaafb61bee9434441b1f158/psrc-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "298202298f09f2bbf8bdb967903290beabd8d8dc206e1f39b08dcae80c264a82",
"md5": "56c372f65fe6867fcd86e31643a63be2",
"sha256": "2b5ac53787601fb1564fd10f81398b1788fc73b71e56b7d09f76ba98e9817e7a"
},
"downloads": -1,
"filename": "psrc-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "56c372f65fe6867fcd86e31643a63be2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 21662,
"upload_time": "2023-11-25T14:20:16",
"upload_time_iso_8601": "2023-11-25T14:20:16.043626Z",
"url": "https://files.pythonhosted.org/packages/29/82/02298f09f2bbf8bdb967903290beabd8d8dc206e1f39b08dcae80c264a82/psrc-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 14:20:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "psrc",
"github_not_found": true,
"lcname": "psrc"
}