# VSCode Python Project Template
Template for my python (version 3) projects with vscode
## Commands
* Init space (with bash) : `source _initial_setup.sh`
* Create virtualenv virtualenv : `virtualenv -p python3 .venv`
* Load/Source virtuelenv : `source .venv/bin/activate`
* Install requirements : `pip install -r requirements.txt`
* Install test requirements : `pip install -r tests/requirements.txt`
* Launch unitary tests : `python3 -m pytest tests -v`
* Launch coverage tests : `python3 -m pytest --cov-report xml:cov.xml --cov my_module tests -v`
## Tools choices
* Format python code with **autopep8**. Others here : <https://code.visualstudio.com/docs/python/editing#_formatting>
* Static analysis with **pylint**. Others here : <https://code.visualstudio.com/docs/python/linting>
* Unitary tests with **pytest**. Others here : <https://code.visualstudio.com/docs/python/unit-testing>
* Available options for python with vscode available here : <<https://code.visualstudio.com/docs/python/settings-referenc>e>
## Extensions
Usefull extensions :
* Python (<https://marketplace.visualstudio.com/items?itemName=ms-python.python)>
* Coverage Gutters (<https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)>
* Better Comments (<https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)>
* indent-rainbow (<https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow)>
* Trailing Spaces (<https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces)>
* Rainbow Brackets (<https://marketplace.visualstudio.com/items?itemName=2gua.rainbow-brackets)>
* Git Lens (<https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)>
* EditorConfig (<https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig>)
* Git Project Manager (<https://marketplace.visualstudio.com/items?itemName=felipecaputo.git-project-manager>)
## Tasks
* Unitary tests with code coverage
## Use it
* Clone this repo as a new vscode workspace
* Create virtualenv and install requirements (see [Commands](Commands))
* Rename folder *my_module* with your module name
* In *.vscode/tasks.json*, replace *my_module* by your module name
* Fix module import in *main.py* and *./tests/test_my_module.yy* if needed
* Try everything by:
* Launching unitary tests
* Launching task
* Launching configurations
* Debugging with a breakpoint
## Sources
* <https://github.com/dwd-umd/python-project-template>
Raw data
{
"_id": null,
"home_page": "",
"name": "config-mgmt-server",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Dotcom Row <dotcom.row@gmail.com>",
"keywords": "config,suncoast systems,router",
"author": "",
"author_email": "Suncoast Systems <administrator@suncoast.systems>",
"download_url": "https://files.pythonhosted.org/packages/d8/e6/e6c6fea85a6769e4d3fc57c29792b85cf2ed1789162be4419a0b21df65d8/config_mgmt_server-1.0.18.tar.gz",
"platform": null,
"description": "# VSCode Python Project Template\n\nTemplate for my python (version 3) projects with vscode\n\n## Commands\n\n* Init space (with bash) : `source _initial_setup.sh`\n* Create virtualenv virtualenv : `virtualenv -p python3 .venv`\n* Load/Source virtuelenv : `source .venv/bin/activate`\n* Install requirements : `pip install -r requirements.txt`\n* Install test requirements : `pip install -r tests/requirements.txt`\n* Launch unitary tests : `python3 -m pytest tests -v`\n* Launch coverage tests : `python3 -m pytest --cov-report xml:cov.xml --cov my_module tests -v`\n\n## Tools choices\n\n* Format python code with **autopep8**. Others here : <https://code.visualstudio.com/docs/python/editing#_formatting>\n* Static analysis with **pylint**. Others here : <https://code.visualstudio.com/docs/python/linting>\n* Unitary tests with **pytest**. Others here : <https://code.visualstudio.com/docs/python/unit-testing>\n\n* Available options for python with vscode available here : <<https://code.visualstudio.com/docs/python/settings-referenc>e>\n\n## Extensions\n\nUsefull extensions :\n\n* Python (<https://marketplace.visualstudio.com/items?itemName=ms-python.python)>\n* Coverage Gutters (<https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)>\n* Better Comments (<https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)>\n* indent-rainbow (<https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow)>\n* Trailing Spaces (<https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces)>\n* Rainbow Brackets (<https://marketplace.visualstudio.com/items?itemName=2gua.rainbow-brackets)>\n* Git Lens (<https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)>\n* EditorConfig (<https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig>)\n* Git Project Manager (<https://marketplace.visualstudio.com/items?itemName=felipecaputo.git-project-manager>)\n\n## Tasks\n\n* Unitary tests with code coverage\n\n## Use it\n\n* Clone this repo as a new vscode workspace\n* Create virtualenv and install requirements (see [Commands](Commands))\n* Rename folder *my_module* with your module name\n* In *.vscode/tasks.json*, replace *my_module* by your module name\n* Fix module import in *main.py* and *./tests/test_my_module.yy* if needed\n* Try everything by:\n * Launching unitary tests\n * Launching task\n * Launching configurations\n * Debugging with a breakpoint\n\n## Sources\n\n* <https://github.com/dwd-umd/python-project-template>\n",
"bugtrack_url": null,
"license": "This project is only for Dotcom Row services, no other use is allowed or even possible!",
"summary": "Suncoast Systems Core Router Config Mgmt Server",
"version": "1.0.18",
"project_urls": {
"Bug Reports": "https://github.com/pypa/sampleproject/issues",
"Funding": "https://donate.pypi.org",
"Homepage": "https://github.com/pypa/sampleproject",
"Say Thanks!": "http://saythanks.io/to/example",
"Source": "https://github.com/pypa/sampleproject/"
},
"split_keywords": [
"config",
"suncoast systems",
"router"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37fdac131ba9212d63e055a9ff4980a491c4127e22a78017cd4f5abc417aa5fc",
"md5": "6de59de87dbbe19a9df0e7f4d02a66fc",
"sha256": "422bff96f4363f28b29704f3aae68dbf3387e909dbce03f3828567c2031cdaf3"
},
"downloads": -1,
"filename": "config_mgmt_server-1.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6de59de87dbbe19a9df0e7f4d02a66fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8900,
"upload_time": "2023-06-06T16:39:21",
"upload_time_iso_8601": "2023-06-06T16:39:21.515770Z",
"url": "https://files.pythonhosted.org/packages/37/fd/ac131ba9212d63e055a9ff4980a491c4127e22a78017cd4f5abc417aa5fc/config_mgmt_server-1.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8e6e6c6fea85a6769e4d3fc57c29792b85cf2ed1789162be4419a0b21df65d8",
"md5": "623733908822eff5d20a5e8c81e51c64",
"sha256": "797873e822907d1d49560f9d73787249bb84385e3941ce8a0452ad0d7fa0577b"
},
"downloads": -1,
"filename": "config_mgmt_server-1.0.18.tar.gz",
"has_sig": false,
"md5_digest": "623733908822eff5d20a5e8c81e51c64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11049,
"upload_time": "2023-06-06T16:39:23",
"upload_time_iso_8601": "2023-06-06T16:39:23.101496Z",
"url": "https://files.pythonhosted.org/packages/d8/e6/e6c6fea85a6769e4d3fc57c29792b85cf2ed1789162be4419a0b21df65d8/config_mgmt_server-1.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 16:39:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypa",
"github_project": "sampleproject",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "config-mgmt-server"
}
JSON
