# A template to structure your Python application
A python project to use as a template when developing a Python application.
## In order to create a Python project with a similar structure you need to do the following:
### The structure of the project should be as follows:
```
project
|-- README.md
|-- Package
|-- init.py
| |-- module_1
| | |-- init.py
| | |-- function1.py
| | |-- ...
| | |-- function_n.py
| |-- module_2
| | |-- init.py
| | |-- function1.py
| | |-- ...
| | |-- function_n.py
| |-- ..
| |-- module_n.py
-- setup.py
```
### Command for wheel creation and upload
* For Python3 users:
* `python setup.py sdist`
* `del dist\*`
* `stwine upload --verbose dist/* `
# ScholarCodeCollective Package
Welcome to the ScholarCodeCollective package. Below you will find links to various resources including our local documentation.
## Documentation
For detailed documentation, please refer to our [local documentation](file:///D:/Research%20HKU/PYPI_lib/Documentation/_build/html/index.html).
(file:///D:/Research%20HKU/PYPI_lib/Documentation/_build/html/index.html)
## Installation
Provide installation instructions here.
## Usage
Provide usage instructions here.
## Contributing
Guidelines for how to contribute to the project.
## License
Information about the licensing.
#\x00 \x00S\x00c\x00h\x00o\x00l\x00a\x00r\x00C\x00o\x00d\x00e\x00C\x00o\x00l\x00l\x00e\x00c\x00t\x00i\x00v\x00e\x00
\x00
\x00
Raw data
{
"_id": null,
"home_page": "https://scholarcodecollective.readthedocs.io/en/latest/index.html",
"name": "ScholarCodeCollective",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Author Name",
"author_email": "baiyueh@hku.hk",
"download_url": "https://files.pythonhosted.org/packages/0f/3d/075eb292f74d22c1c0a80bccb8638bd6cdcdfe3172cb904d0eaef5036015/ScholarCodeCollective-0.1.8.6.tar.gz",
"platform": null,
"description": "# A template to structure your Python application\r\nA python project to use as a template when developing a Python application.\r\n\r\n## In order to create a Python project with a similar structure you need to do the following: \r\n### The structure of the project should be as follows: \r\n```\r\nproject\r\n|-- README.md\r\n|-- Package\r\n|-- init.py\r\n| |-- module_1\r\n| | |-- init.py\r\n| | |-- function1.py\r\n| | |-- ...\r\n| | |-- function_n.py \r\n| |-- module_2\r\n| | |-- init.py\r\n| | |-- function1.py\r\n| | |-- ...\r\n| | |-- function_n.py \r\n| |-- ..\r\n| |-- module_n.py \r\n-- setup.py \r\n```\r\n### Command for wheel creation and upload \r\n* For Python3 users: \r\n * `python setup.py sdist`\r\n * `del dist\\*`\r\n * `stwine upload --verbose dist/* `\r\n\r\n# ScholarCodeCollective Package\r\n\r\nWelcome to the ScholarCodeCollective package. Below you will find links to various resources including our local documentation.\r\n\r\n## Documentation\r\n\r\nFor detailed documentation, please refer to our [local documentation](file:///D:/Research%20HKU/PYPI_lib/Documentation/_build/html/index.html).\r\n(file:///D:/Research%20HKU/PYPI_lib/Documentation/_build/html/index.html)\r\n\r\n## Installation\r\n\r\nProvide installation instructions here.\r\n\r\n## Usage\r\n\r\nProvide usage instructions here.\r\n\r\n## Contributing\r\n\r\nGuidelines for how to contribute to the project.\r\n\r\n## License\r\n\r\nInformation about the licensing.\r\n#\\x00 \\x00S\\x00c\\x00h\\x00o\\x00l\\x00a\\x00r\\x00C\\x00o\\x00d\\x00e\\x00C\\x00o\\x00l\\x00l\\x00e\\x00c\\x00t\\x00i\\x00v\\x00e\\x00\r\n\\x00\r\n\\x00\r\n",
"bugtrack_url": null,
"license": "The Unlicense",
"summary": "A collective library for the code behind several academic papers",
"version": "0.1.8.6",
"project_urls": {
"Homepage": "https://scholarcodecollective.readthedocs.io/en/latest/index.html"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f3d075eb292f74d22c1c0a80bccb8638bd6cdcdfe3172cb904d0eaef5036015",
"md5": "7de3e794a71748c0ff7222d256ec9027",
"sha256": "63bb56cdb01a03ad0173f145c35880078be967aa852ae842a97c9384d8bd1791"
},
"downloads": -1,
"filename": "ScholarCodeCollective-0.1.8.6.tar.gz",
"has_sig": false,
"md5_digest": "7de3e794a71748c0ff7222d256ec9027",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 21045,
"upload_time": "2024-07-24T13:04:26",
"upload_time_iso_8601": "2024-07-24T13:04:26.733903Z",
"url": "https://files.pythonhosted.org/packages/0f/3d/075eb292f74d22c1c0a80bccb8638bd6cdcdfe3172cb904d0eaef5036015/ScholarCodeCollective-0.1.8.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-24 13:04:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "scholarcodecollective"
}
JSON