| Name | startnewproject JSON |
| Version |
0.1.6
JSON |
| download |
| home_page | None |
| Summary | This package provides a command to create a new project folder with subfolders, READMEs, pylabnotebook and git. |
| upload_time | 2024-09-19 19:11:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
project
organization
folder
new
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">Startnewproject 🖥🗂️</h1>
This package includes a function to create a new project folderm with the desired tree, git and pylabnotebook initialized.
**DEPENDENCY**: this tool depends on git and <a href="https://github.com/mmiots9/pylabnotebook" target="_blank">pylabnotebook</a>. Please install git and configure it prior to using this package.
<h3 style="margin-bottom:3px;">Features</h3>
<ul>
<li>Automatically create folder tree based on the configuration file</li>
<li>Customizable configuration file</li>
<li>Pre-compiled README in each folder, with the desired format (.txt, .md, or .html)</li>
<li>Git initialization, with .gitignore and .gitattributes as well</li>
<li>pylabnotebook initialization</li>
</ul>
<h3>Installation</h3>
To install the package, run:
```
pip install startnewproject
```
This will install the startnewproject package, as weel as its dependency; you can then run <code>startnewproject</code> function from within the terminal (detailed explanation below).
<h3>Start a new project</h3>
To start a new project, just run
```
startnewproject -n name_of_the_project
```
If you want to have spaces in your name, just wrap it into quotes. If the folder already exists, an error will be returned; use <code>-f/--force</code> to overwrite the existing folder.
A folder is created with the default tree structure.
<h3>Costumize configuration</h3>
To use a costumize tree structure, you have to provide a configuration file structured like the one in <code>templates/config.json</code> as input with the <code>-c/--config</code> flag.<br>
It must be a .json file containing as keys: "description" (a string, can be empty), "subfolders" (a dictionary of subfolders. Check the template to see an example), "files" (a list of file names, can be empty), ".gitignore" (a list of patterns to include in .gitignore), ".gitattributes" (a dictionary of things to include in .gitattributes. Check the template for an example).
<h3>Issue reporting and suggestions</h3>
If you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "startnewproject",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "project, organization, folder, new",
"author": null,
"author_email": "Matteo Miotto <miotsdata@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/86/af/44b6afc2195ccb678fb16e888a9848821ac710962d495620ba1903e5caff/startnewproject-0.1.6.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Startnewproject \ud83d\udda5\ud83d\uddc2\ufe0f</h1>\n\nThis package includes a function to create a new project folderm with the desired tree, git and pylabnotebook initialized.\n\n**DEPENDENCY**: this tool depends on git and <a href=\"https://github.com/mmiots9/pylabnotebook\" target=\"_blank\">pylabnotebook</a>. Please install git and configure it prior to using this package.\n\n<h3 style=\"margin-bottom:3px;\">Features</h3>\n<ul>\n <li>Automatically create folder tree based on the configuration file</li>\n <li>Customizable configuration file</li>\n <li>Pre-compiled README in each folder, with the desired format (.txt, .md, or .html)</li>\n <li>Git initialization, with .gitignore and .gitattributes as well</li>\n <li>pylabnotebook initialization</li>\n</ul>\n\n<h3>Installation</h3>\nTo install the package, run:\n\n```\npip install startnewproject\n```\n\nThis will install the startnewproject package, as weel as its dependency; you can then run <code>startnewproject</code> function from within the terminal (detailed explanation below).\n\n<h3>Start a new project</h3>\nTo start a new project, just run\n\n```\nstartnewproject -n name_of_the_project\n```\n\nIf you want to have spaces in your name, just wrap it into quotes. If the folder already exists, an error will be returned; use <code>-f/--force</code> to overwrite the existing folder.\nA folder is created with the default tree structure.\n\n<h3>Costumize configuration</h3>\nTo use a costumize tree structure, you have to provide a configuration file structured like the one in <code>templates/config.json</code> as input with the <code>-c/--config</code> flag.<br>\nIt must be a .json file containing as keys: \"description\" (a string, can be empty), \"subfolders\" (a dictionary of subfolders. Check the template to see an example), \"files\" (a list of file names, can be empty), \".gitignore\" (a list of patterns to include in .gitignore), \".gitattributes\" (a dictionary of things to include in .gitattributes. Check the template for an example).\n\n<h3>Issue reporting and suggestions</h3>\nIf you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This package provides a command to create a new project folder with subfolders, READMEs, pylabnotebook and git.",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/mmiots9/startnewproject",
"Issues": "https://github.com/mmiots9/startnewproject/issues"
},
"split_keywords": [
"project",
" organization",
" folder",
" new"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fcb051d8eadf5c48283f12c81e5e11217ec8b536c81cab233ec8587ff65d06be",
"md5": "059353f5aca33a715881deab226a2c53",
"sha256": "69117a7155cdb092913ec63ff97ef7409d51de48698d0041242c95713afb68ca"
},
"downloads": -1,
"filename": "startnewproject-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "059353f5aca33a715881deab226a2c53",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8046,
"upload_time": "2024-09-19T19:11:21",
"upload_time_iso_8601": "2024-09-19T19:11:21.011125Z",
"url": "https://files.pythonhosted.org/packages/fc/b0/51d8eadf5c48283f12c81e5e11217ec8b536c81cab233ec8587ff65d06be/startnewproject-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86af44b6afc2195ccb678fb16e888a9848821ac710962d495620ba1903e5caff",
"md5": "e8015fc3f9054e04f28e1b51394b32dc",
"sha256": "d30fa8eb4206dd5c19ab756cd1a6b6ba4bd831fa03b696b6c9528673dc66aaf8"
},
"downloads": -1,
"filename": "startnewproject-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "e8015fc3f9054e04f28e1b51394b32dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7132,
"upload_time": "2024-09-19T19:11:23",
"upload_time_iso_8601": "2024-09-19T19:11:23.064325Z",
"url": "https://files.pythonhosted.org/packages/86/af/44b6afc2195ccb678fb16e888a9848821ac710962d495620ba1903e5caff/startnewproject-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 19:11:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mmiots9",
"github_project": "startnewproject",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "startnewproject"
}
