# README
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Get started
- Create a new project using this template
- run `make init_repository` to initialize the repo for nbdev
- run `nbdev_preview` to makesure nbdev renders the website
- modify `setting.ini` and `_quarto.yml` as needed to reflect names and
hyperlinks of this project
- add notebook in the `nbs` folder and start building software
- `git add`, `git commit`, `git push` to save your work
## Deploy manually
- `make deploy_to_githubpage` to deploy the website to github pages
- from github, go to `Settings` -\> `Pages` to set the source of the
github page to `main` branch and `/docs` folder and `save`
- visit the website at `https://<username>.github.io/<project_name>`
- in the future you can run `make deploy_to_githubpage` to update the
website automatically
## Deploy automatically
- first, go to `Settings` -\> `Actions` -\> `general` -\>
`Workflows Permissions` and enable `Read and write access` for
`Actions` and `Workflows`
- from github, go to `Settings` -\> `Pages` to set the source of the
github page to `github-pages` branch root folder and `save`
- with github action, the website will be automatically deployed to
github pages when you push to the `main` branch
- visit the website at `https://<username>.github.io/<project_name>`
- in the future the website will be updated automatically via github
action after every push to the `main` branch
## Local development and deployment
- `nbdev_preview` to preview the website locally
- `nbdev_export` to export the the library
- `pip install -e .` to install the library in editable mode
- `nbdev_pypi` to build the package and upload to pypi
## License
- add appropriate license to the project by modifying `LICENSE` file.
Instructions can be found
[here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)
## Happy Coding!
``` python
1+1
```
2
``` python
print("Hello World!")
```
Hello World!
Raw data
{
"_id": null,
"home_page": "https://github.com/hdocmsu/hdo_nbdev_template/",
"name": "hdo-nbdev-template",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev, mri, medical imaging, deep learning, magnetic resonance imaging",
"author": "Hung P. Do, PhD, MSEE",
"author_email": "clinicalcollaborations@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/83/22/6ad11ba33c1274ab674e07aaf308b5c811d0d37014155096404838dd7979/hdo_nbdev_template-0.0.1.tar.gz",
"platform": null,
"description": "# README\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Get started\n\n- Create a new project using this template\n\n- run `make init_repository` to initialize the repo for nbdev\n\n- run `nbdev_preview` to makesure nbdev renders the website\n\n- modify `setting.ini` and `_quarto.yml` as needed to reflect names and\n hyperlinks of this project\n\n- add notebook in the `nbs` folder and start building software\n\n- `git add`, `git commit`, `git push` to save your work\n\n## Deploy manually\n\n- `make deploy_to_githubpage` to deploy the website to github pages\n\n- from github, go to `Settings` -\\> `Pages` to set the source of the\n github page to `main` branch and `/docs` folder and `save`\n\n- visit the website at `https://<username>.github.io/<project_name>`\n\n- in the future you can run `make deploy_to_githubpage` to update the\n website automatically\n\n## Deploy automatically\n\n- first, go to `Settings` -\\> `Actions` -\\> `general` -\\>\n `Workflows Permissions` and enable `Read and write access` for\n `Actions` and `Workflows`\n\n- from github, go to `Settings` -\\> `Pages` to set the source of the\n github page to `github-pages` branch root folder and `save`\n\n- with github action, the website will be automatically deployed to\n github pages when you push to the `main` branch\n\n- visit the website at `https://<username>.github.io/<project_name>`\n\n- in the future the website will be updated automatically via github\n action after every push to the `main` branch\n\n## Local development and deployment\n\n- `nbdev_preview` to preview the website locally\n\n- `nbdev_export` to export the the library\n\n- `pip install -e .` to install the library in editable mode\n\n- `nbdev_pypi` to build the package and upload to pypi\n\n## License\n\n- add appropriate license to the project by modifying `LICENSE` file.\n Instructions can be found\n [here](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)\n\n## Happy Coding!\n\n``` python\n1+1\n```\n\n 2\n\n``` python\nprint(\"Hello World!\")\n```\n\n Hello World!\n",
"bugtrack_url": null,
"license": "None",
"summary": "project page",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/hdocmsu/hdo_nbdev_template/"
},
"split_keywords": [
"nbdev",
" mri",
" medical imaging",
" deep learning",
" magnetic resonance imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71ec0cfe10c91e609f24dddc338838cd47da97d02b386a5cf3c71bc796d5ba54",
"md5": "b66f52990a2b7d89b75914d6dcec3be0",
"sha256": "722103a207157b56e1cd794f64619dc4dd4a550b0af5a1637afc10b09dad973d"
},
"downloads": -1,
"filename": "hdo_nbdev_template-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b66f52990a2b7d89b75914d6dcec3be0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3825,
"upload_time": "2024-08-31T17:20:22",
"upload_time_iso_8601": "2024-08-31T17:20:22.364466Z",
"url": "https://files.pythonhosted.org/packages/71/ec/0cfe10c91e609f24dddc338838cd47da97d02b386a5cf3c71bc796d5ba54/hdo_nbdev_template-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83226ad11ba33c1274ab674e07aaf308b5c811d0d37014155096404838dd7979",
"md5": "a63f78f0bbb32073cd4a22e408218337",
"sha256": "c61c50e5fa87bae1e81d57ab32590aa36a3ae01c8f6ef20e875df3d6c0b8936c"
},
"downloads": -1,
"filename": "hdo_nbdev_template-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a63f78f0bbb32073cd4a22e408218337",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3884,
"upload_time": "2024-08-31T17:20:23",
"upload_time_iso_8601": "2024-08-31T17:20:23.461757Z",
"url": "https://files.pythonhosted.org/packages/83/22/6ad11ba33c1274ab674e07aaf308b5c811d0d37014155096404838dd7979/hdo_nbdev_template-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 17:20:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hdocmsu",
"github_project": "hdo_nbdev_template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hdo-nbdev-template"
}
JSON
