=====================================================
A project for managing bss local virtual environments
=====================================================
Summary
===============
This project contains packages and scripts responsible for managing bss local virtual environments
Commands
===============
| **Prepare virtual environment**
| cd bssenv
| pipenv install --dev # this will also create new virtual environment for project
| > set generated virtual enviroment for this project in your IDE
| **Add new or upgrade some dependency**
| cd bssenv
| > edit Pipfile
| pipenv update --dev
| pipenv requirements > ./src/comarch/bss/bssenv/data/python_site_packages/requirements.txt
| **Build**
| cd bssenv
| pipenv shell
| python -m build --sdist
| **Publish**
| cd bssenv
| pipenv shell
| twine upload dist/\*.tar.gz
| **Install prerequisites:**
| python3 version >= 3.8
| sudo pip3 install setuptools --upgrade
| pip3 install setuptools --upgrade --user
| **Install package from sdist (tar.gz) as root:**
| sudo python3 -m pip install --force --upgrade dist/bssenv-2.8.0.tar.gz
| **Install package from sdist (tar.gz) as normal user:**
| python3 -m pip install --user --force --upgrade dist/bssenv-2.8.0.tar.gz
| **Install package from sdist (tar.gz) as normal user with verbose messages:**
| python3 -m pip -v install --user --force --upgrade dist/bssenv-2.8.0.tar.gz
| **Install package from internal PYPI as root:**
| sudo python3 -m pip install --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv
| **Install package from internal PYPI as normal user:**
| python3 -m pip install --user --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv
| **Install package from internal PYPI as normal user with verbose messages:**
| python3 -m pip install --user -v --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv
| **Enable debug mode**
| export BSSENV_LOG_LEVEL=debug
| **Uninstall**
| pip3 uninstall bssenv
TESTS
================
Prerequisites:
________________________
Pyenv
^^^^^^^^^^^^^^^^^^^^
| https://github.com/pyenv/pyenv
| https://github.com/pyenv/pyenv-installer
| **Installation on Ubuntu/Debian**:
* curl https://pyenv.run | bash
* echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
* echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.profile
* echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.profile
* echo 'eval "$(pyenv init --path)"' >> ~/.profile
Tox
^^^^^^^^^^^^^^
| **Main tool**:
* https://pypi.org/project/tox/
| **Tox plugins**:
* https://pypi.org/project/tox-venv/ (To use module venv instead of virtualenv package to create test environments)
* https://github.com/pojx/tox-pyenv-install (To automatically install required python version on venv using 'pyenv install')
| **Tox installation**
* pip install tox
| **Plugins installation**
* pip install tox-venv
* git clone https://github.com/pojx/tox-pyenv-install.git
* cd tox-pyenv-install && pip install .
Run tests:
________________________
| **Normal mode**:
* tox
| **Use already created environment 'env_name'**:
* tox -- --env env_name
| **Install given version on bssenv environment during tests**:
* tox -- --v 'version' e.g. tox -- -v 7.7.6.0-ibu
| **Use given remote env snapshot**:
* tox -- --remote_env_snapshot 'env_snapshot_name'
| **Run restoring env from snapshot tests and further tests on remote server**
* tox -- --use_remote_server
| **Capturing stdout**:
* tox (Default option. Stdout is saved in the reports and not visible during tests)
* tox -- -s (Stdout is visible during tests and not saved in the report)
Raw data
{
"_id": null,
"home_page": "",
"name": "bssenv",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Hubert Tarnacki <hubert.tarnacki@comarch.com>",
"keywords": "bss,environment,docker,devops,bssenv",
"author": "",
"author_email": "Hubert Tarnacki <hubert.tarnacki@comarch.com>",
"download_url": "https://files.pythonhosted.org/packages/54/e7/6f2365597ea37f630e8fa75b72e9906e936966fc24478764d7abee0688ff/bssenv-2.8.1.tar.gz",
"platform": null,
"description": "=====================================================\nA project for managing bss local virtual environments\n=====================================================\n\nSummary\n===============\nThis project contains packages and scripts responsible for managing bss local virtual environments\n\nCommands\n===============\n| **Prepare virtual environment**\n| cd bssenv\n| pipenv install --dev # this will also create new virtual environment for project\n| > set generated virtual enviroment for this project in your IDE\n\n| **Add new or upgrade some dependency**\n| cd bssenv\n| > edit Pipfile\n| pipenv update --dev\n| pipenv requirements > ./src/comarch/bss/bssenv/data/python_site_packages/requirements.txt\n\n| **Build**\n| cd bssenv\n| pipenv shell\n| python -m build --sdist\n\n| **Publish**\n| cd bssenv\n| pipenv shell\n| twine upload dist/\\*.tar.gz\n\n| **Install prerequisites:**\n| python3 version >= 3.8\n| sudo pip3 install setuptools --upgrade\n| pip3 install setuptools --upgrade --user\n\n| **Install package from sdist (tar.gz) as root:**\n| sudo python3 -m pip install --force --upgrade dist/bssenv-2.8.0.tar.gz\n| **Install package from sdist (tar.gz) as normal user:**\n| python3 -m pip install --user --force --upgrade dist/bssenv-2.8.0.tar.gz\n| **Install package from sdist (tar.gz) as normal user with verbose messages:**\n| python3 -m pip -v install --user --force --upgrade dist/bssenv-2.8.0.tar.gz\n| **Install package from internal PYPI as root:**\n| sudo python3 -m pip install --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv\n\n| **Install package from internal PYPI as normal user:**\n| python3 -m pip install --user --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv\n\n| **Install package from internal PYPI as normal user with verbose messages:**\n| python3 -m pip install --user -v --no-cache --force --upgrade --extra-index-url http://devops-telco.krakow.comarch:8080/simple --trusted-host devops-telco.krakow.comarch bssenv\n\n| **Enable debug mode**\n| export BSSENV_LOG_LEVEL=debug\n\n| **Uninstall**\n| pip3 uninstall bssenv\n\n\nTESTS\n================\nPrerequisites:\n________________________\nPyenv\n^^^^^^^^^^^^^^^^^^^^\n| https://github.com/pyenv/pyenv\n| https://github.com/pyenv/pyenv-installer\n\n| **Installation on Ubuntu/Debian**:\n\n* curl https://pyenv.run | bash\n* echo 'eval \"$(pyenv virtualenv-init -)\"' >> ~/.bashrc\n* echo 'export PYENV_ROOT=\"$HOME/.pyenv\"' >> ~/.profile\n* echo 'export PATH=\"$PYENV_ROOT/bin:$PATH\"' >> ~/.profile\n* echo 'eval \"$(pyenv init --path)\"' >> ~/.profile\n\nTox\n^^^^^^^^^^^^^^\n| **Main tool**:\n\n* https://pypi.org/project/tox/\n\n| **Tox plugins**:\n\n* https://pypi.org/project/tox-venv/ (To use module venv instead of virtualenv package to create test environments)\n* https://github.com/pojx/tox-pyenv-install (To automatically install required python version on venv using 'pyenv install')\n\n| **Tox installation**\n\n* pip install tox\n\n| **Plugins installation**\n\n* pip install tox-venv\n* git clone https://github.com/pojx/tox-pyenv-install.git\n* cd tox-pyenv-install && pip install .\n\nRun tests:\n________________________\n| **Normal mode**:\n\n* tox\n\n| **Use already created environment 'env_name'**:\n\n* tox -- --env env_name\n\n| **Install given version on bssenv environment during tests**:\n\n* tox -- --v 'version' e.g. tox -- -v 7.7.6.0-ibu\n\n| **Use given remote env snapshot**:\n\n* tox -- --remote_env_snapshot 'env_snapshot_name'\n\n| **Run restoring env from snapshot tests and further tests on remote server**\n\n* tox -- --use_remote_server\n\n| **Capturing stdout**:\n\n* tox (Default option. Stdout is saved in the reports and not visible during tests)\n* tox -- -s (Stdout is visible during tests and not saved in the report)\n",
"bugtrack_url": null,
"license": "Other/Proprietary License",
"summary": "A project for managing bss local, dockerized environments",
"version": "2.8.1",
"project_urls": {
"Bug-Reports": "https://tapir.krakow.comarch/jira/projects/BSSREL",
"Documentation": "https://wiki.comarch/display/BSSRND/bssenv",
"Homepage": "https://wiki.comarch/display/BSSRND/bssenv",
"Repository": "http://r7.krakow.comarch:8000/Aurel/bssenv"
},
"split_keywords": [
"bss",
"environment",
"docker",
"devops",
"bssenv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54e76f2365597ea37f630e8fa75b72e9906e936966fc24478764d7abee0688ff",
"md5": "154317e3f1df8990aaaa4459ed07a580",
"sha256": "aa8eff3e035fd07be9513526fd9a9724d1d12d8e47d7cd22e46c8672533d71d9"
},
"downloads": -1,
"filename": "bssenv-2.8.1.tar.gz",
"has_sig": false,
"md5_digest": "154317e3f1df8990aaaa4459ed07a580",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 113927,
"upload_time": "2023-07-12T06:17:46",
"upload_time_iso_8601": "2023-07-12T06:17:46.243462Z",
"url": "https://files.pythonhosted.org/packages/54/e7/6f2365597ea37f630e8fa75b72e9906e936966fc24478764d7abee0688ff/bssenv-2.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 06:17:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bssenv"
}
JSON