# workon-poetry
Bash and Python scripts to make switching and starting projects more efficient and less error-prone by automating some of the boring stuff and incorporating some opinions about best practices.
## Dependencies
* poetry
* virtualenv
## Setup your Python environment
Launch a `terminal` on Linux (or `git-bash` on Windows) then:
1. Update your pip and virtualenv packages
2. Clone the `workon-poetry` project
3. Create a virtualenv within the `workon-poetry` dir
4. Activate your new Python virtual environment
5. Install this Python package in "--editable" mode
Any Python version greater than `3.7` should work.
As of 2023 most Linux systems use Python `3.9` or higher:
```bash
pip install --upgrade virtualenv poetry
git clone git@gitlab.com:tangibleai/community/workon-poetry
cd workon-poetry
python -m virtualenv --python 3.9 .venv
ls -hal
```
You should see a new `.venv/` directory.
It will contain your python interpreter and a few `site-packages` like `pip` and `distutils`.
Now activate your new virtual environment by sourcing `.venv/bin/activate` (on Linux) or `.venv/scripts/activate` (on Windows).
```bash
# bin/activate on Linux OR `Scripts/activate` in git-bash on Windows
source .venv/bin/activate || source .venv/Scripts/activate
```
## Developer install
Once you have a shiny new virtual environment activated you can install `workon-poetry` in `--editable` mode.
This way, when you edit the files and have the package change immediately.
Make sure you are already within your cloned `workon-poetry` project directory.
And makes sure your virtual environment is activated.
You should see the name of your virtual environment in parentheses within your command line prompt, like `(.venv) $`.
Then when you install `workon-poetry` it will be available for import within any other Python application in that virtual environment.
```bash
pip install --editable .
```
## User install
If you don't want to contribute, and you just want to **USE** `workon-poetry` the MathText modules, you can install it from a binary wheel on PyPi:
```bash
pip install workon-poetry
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/tangibleai/community/workon-poetry",
"name": "workon-poetry",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Hobson Lane",
"author_email": "gitlab@totalgood.com",
"download_url": "https://files.pythonhosted.org/packages/23/fc/965fd41f08228f69609767196ceb3c265772f843dd20c993eefb9215e1d2/workon_poetry-0.0.4.tar.gz",
"platform": null,
"description": "# workon-poetry\n\nBash and Python scripts to make switching and starting projects more efficient and less error-prone by automating some of the boring stuff and incorporating some opinions about best practices.\n\n## Dependencies\n\n* poetry\n* virtualenv\n\n## Setup your Python environment\n\nLaunch a `terminal` on Linux (or `git-bash` on Windows) then:\n\n1. Update your pip and virtualenv packages\n2. Clone the `workon-poetry` project\n3. Create a virtualenv within the `workon-poetry` dir\n4. Activate your new Python virtual environment\n5. Install this Python package in \"--editable\" mode\n\nAny Python version greater than `3.7` should work.\nAs of 2023 most Linux systems use Python `3.9` or higher: \n\n```bash\npip install --upgrade virtualenv poetry\ngit clone git@gitlab.com:tangibleai/community/workon-poetry\ncd workon-poetry\npython -m virtualenv --python 3.9 .venv\nls -hal\n```\n\nYou should see a new `.venv/` directory.\nIt will contain your python interpreter and a few `site-packages` like `pip` and `distutils`.\n\nNow activate your new virtual environment by sourcing `.venv/bin/activate` (on Linux) or `.venv/scripts/activate` (on Windows).\n\n```bash\n# bin/activate on Linux OR `Scripts/activate` in git-bash on Windows\nsource .venv/bin/activate || source .venv/Scripts/activate\n```\n\n## Developer install\n\nOnce you have a shiny new virtual environment activated you can install `workon-poetry` in `--editable` mode.\nThis way, when you edit the files and have the package change immediately.\n\nMake sure you are already within your cloned `workon-poetry` project directory.\nAnd makes sure your virtual environment is activated.\nYou should see the name of your virtual environment in parentheses within your command line prompt, like `(.venv) $`.\nThen when you install `workon-poetry` it will be available for import within any other Python application in that virtual environment.\n\n```bash\npip install --editable .\n```\n\n## User install\n\nIf you don't want to contribute, and you just want to **USE** `workon-poetry` the MathText modules, you can install it from a binary wheel on PyPi:\n\n```bash\npip install workon-poetry\n```\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Natural Language Understanding (text processing) for math symbols, digits, and words with a Gradio user interface and REST API.",
"version": "0.0.4",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94769f68f9d7cc41e52136633427c063e75c1bf3d137c90f258c1d294a93dcd1",
"md5": "5a965cb5e267b104a3e26da643032bd0",
"sha256": "8a396c75539d309a76c3dbae12e86b2475847a61aac9abba624ee7de55386974"
},
"downloads": -1,
"filename": "workon_poetry-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a965cb5e267b104a3e26da643032bd0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 3690,
"upload_time": "2023-03-30T01:51:57",
"upload_time_iso_8601": "2023-03-30T01:51:57.346815Z",
"url": "https://files.pythonhosted.org/packages/94/76/9f68f9d7cc41e52136633427c063e75c1bf3d137c90f258c1d294a93dcd1/workon_poetry-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23fc965fd41f08228f69609767196ceb3c265772f843dd20c993eefb9215e1d2",
"md5": "b43ad07fdfa01b7c33434b4e08d71b3a",
"sha256": "73855acb29b3180e3a0f484d72bef663a3b0dddc09771d68a80bda53619e8084"
},
"downloads": -1,
"filename": "workon_poetry-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "b43ad07fdfa01b7c33434b4e08d71b3a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2882,
"upload_time": "2023-03-30T01:51:59",
"upload_time_iso_8601": "2023-03-30T01:51:59.318130Z",
"url": "https://files.pythonhosted.org/packages/23/fc/965fd41f08228f69609767196ceb3c265772f843dd20c993eefb9215e1d2/workon_poetry-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-30 01:51:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "workon-poetry"
}
JSON