# nbdirs
<!-- 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 nbdirs --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install nbdirs
```
### nbdev
``` sh
# activate conda environment
$ conda activate nbdirs
# make sure the nbdirs package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the nbdirs 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/nbdirs):
``` sh
$ pip install git+https://github.com/dsm-72/nbdirs.git
```
or from [conda](https://anaconda.org/dsm-72/nbdirs)
``` sh
$ conda install -c dsm-72 nbdirs
```
or from [pypi](https://pypi.org/project/nbdirs/)
``` sh
$ pip install nbdirs
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/nbdirs)
[pages](https://dsm-72.github.io/nbdirs/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/nbdirs) and
[pypi](https://pypi.org/project/nbdirs/) respectively.
``` python
NBDirs.makedirs(verbose=True)
```
DATA:
- path = /Users/solst/Projects/nbdirs/data
- desc = The default directory for data files.
EXPL:
- path = /Users/solst/Projects/nbdirs/examples
- desc = The directory containing all example notebooks.
FIGS:
- path = /Users/solst/Projects/nbdirs/figures
- desc = The default directory for figures.
NBKS:
- path = /Users/solst/Projects/nbdirs/nbs
- desc = The directory containing all nbdev notebooks.
root:
- path = /Users/solst/Projects/nbdirs/nbs
- desc = The root directory
RSLT:
- path = /Users/solst/Projects/nbdirs/results
- desc = The default directory for results.
{'DATA_DIR': NBDir(/Users/solst/Projects/nbdirs/data),
'EXPL_DIR': NBDir(/Users/solst/Projects/nbdirs/examples),
'FIGS_DIR': NBDir(/Users/solst/Projects/nbdirs/figures),
'NBKS_DIR': NBDir(/Users/solst/Projects/nbdirs/nbs),
'ROOT_DIR': NBDir(/Users/solst/Projects/nbdirs/nbs),
'RSLT_DIR': NBDir(/Users/solst/Projects/nbdirs/results)}
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/nbdirs",
"name": "nbdirs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python nbdirs",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/64/f3/92364c168b622862b578bbf45abcbaf09aa938b653abdcf0029c11a1b00c/nbdirs-0.0.8.tar.gz",
"platform": null,
"description": "# nbdirs\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 nbdirs --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install nbdirs\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate nbdirs\n\n# make sure the nbdirs 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 nbdirs 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/nbdirs):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/nbdirs.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/nbdirs)\n\n``` sh\n$ conda install -c dsm-72 nbdirs\n```\n\nor from [pypi](https://pypi.org/project/nbdirs/)\n\n``` sh\n$ pip install nbdirs\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/nbdirs)\n[pages](https://dsm-72.github.io/nbdirs/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/nbdirs) and\n[pypi](https://pypi.org/project/nbdirs/) respectively.\n\n``` python\nNBDirs.makedirs(verbose=True)\n```\n\n DATA:\n - path = /Users/solst/Projects/nbdirs/data\n - desc = The default directory for data files.\n\n EXPL:\n - path = /Users/solst/Projects/nbdirs/examples\n - desc = The directory containing all example notebooks.\n\n FIGS:\n - path = /Users/solst/Projects/nbdirs/figures\n - desc = The default directory for figures.\n\n NBKS:\n - path = /Users/solst/Projects/nbdirs/nbs\n - desc = The directory containing all nbdev notebooks.\n\n root:\n - path = /Users/solst/Projects/nbdirs/nbs\n - desc = The root directory\n\n RSLT:\n - path = /Users/solst/Projects/nbdirs/results\n - desc = The default directory for results.\n\n {'DATA_DIR': NBDir(/Users/solst/Projects/nbdirs/data),\n 'EXPL_DIR': NBDir(/Users/solst/Projects/nbdirs/examples),\n 'FIGS_DIR': NBDir(/Users/solst/Projects/nbdirs/figures),\n 'NBKS_DIR': NBDir(/Users/solst/Projects/nbdirs/nbs),\n 'ROOT_DIR': NBDir(/Users/solst/Projects/nbdirs/nbs),\n 'RSLT_DIR': NBDir(/Users/solst/Projects/nbdirs/results)}\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "utility for scaffolding nbdev projects",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/dsm-72/nbdirs"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"nbdirs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c30093668bc5b4789179357f0565c9949677a723ccbfe7efa8dfc3068d151b9f",
"md5": "681bfe92a9887c7d71424752061a1dbd",
"sha256": "9b88d8f10ba2aa965a8d018a06f58b7caf24f451fbf7b2206d0090111761b573"
},
"downloads": -1,
"filename": "nbdirs-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "681bfe92a9887c7d71424752061a1dbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15493,
"upload_time": "2023-10-26T18:51:26",
"upload_time_iso_8601": "2023-10-26T18:51:26.546445Z",
"url": "https://files.pythonhosted.org/packages/c3/00/93668bc5b4789179357f0565c9949677a723ccbfe7efa8dfc3068d151b9f/nbdirs-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64f392364c168b622862b578bbf45abcbaf09aa938b653abdcf0029c11a1b00c",
"md5": "76b37518b5932563f3ffb9ef3ce5bbc0",
"sha256": "27d51c1f937d98cda3205b9407fe27b7264f899e04d7aa4cff04cb84cbf5b615"
},
"downloads": -1,
"filename": "nbdirs-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "76b37518b5932563f3ffb9ef3ce5bbc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13496,
"upload_time": "2023-10-26T18:51:27",
"upload_time_iso_8601": "2023-10-26T18:51:27.879288Z",
"url": "https://files.pythonhosted.org/packages/64/f3/92364c168b622862b578bbf45abcbaf09aa938b653abdcf0029c11a1b00c/nbdirs-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 18:51:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "nbdirs",
"github_not_found": true,
"lcname": "nbdirs"
}
JSON
