| Name | plxcontroller JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | Controllers to create and modify Plaxis 2D and 3D models with enhanced functionalities. |
| upload_time | 2024-10-31 22:54:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
plxcontroller
cems
plaxis automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# plxcontroller
Controllers to create and modify Plaxis 2D and 3D models with enhanced functionalities.
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
This repository is created by [CEMS BV](https://cemsbv.nl/).
# Installation
To install a package in this repository run:
`$ pip install plxcontroller`
# Contribution
## Environment
We recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:
Example using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:
```bash
python -m venv .env
source .env/bin/activate
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
```
## Format
We format our code with black and isort.
```bash
black --config "pyproject.toml" src/plxcontroller tests notebooks
isort --settings-path "pyproject.toml" src/plxcontroller tests notebooks
```
## Lint
To maintain code quality we use the GitHub super-linter.
To run the linters locally, run the `run_super_linter.sh` bash script from the root directory.
## UnitTest
Test the software with the use of coverage:
```bash
python -m pip install --upgrade pip setuptools
pip install -r requirements.txt
pip install -e .
coverage run -m pytest
```
## Requirements
Requirements are autogenerated by the `pip-compile` command with python 3.9
Install pip-tools with:
```bash
pip install pip-tools
```
Generate requirements.txt file with:
```bash
pip-compile --extra=test --extra=lint --output-file=requirements.txt pyproject.toml
```
Update the requirements within the defined ranges with:
```bash
pip-compile --upgrade --extra=test --extra=lint --output-file=requirements.txt pyproject.toml
```
Raw data
{
"_id": null,
"home_page": null,
"name": "plxcontroller",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "plxcontroller, CEMS, PLAXIS automation",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/63/af/c48cb643b2069c4780ab26be0afa90b305fb7e6e4cb46d3ca1d530d4dcd9/plxcontroller-0.8.1.tar.gz",
"platform": null,
"description": "# plxcontroller\nControllers to create and modify Plaxis 2D and 3D models with enhanced functionalities.\n\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n\n\nThis repository is created by [CEMS BV](https://cemsbv.nl/).\n\n# Installation\n\nTo install a package in this repository run:\n\n`$ pip install plxcontroller`\n\n# Contribution\n\n## Environment\n\nWe recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:\n\nExample using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:\n\n```bash\npython -m venv .env\nsource .env/bin/activate\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\n```\n\n## Format\n\nWe format our code with black and isort.\n\n```bash\nblack --config \"pyproject.toml\" src/plxcontroller tests notebooks\nisort --settings-path \"pyproject.toml\" src/plxcontroller tests notebooks\n```\n\n## Lint\n\nTo maintain code quality we use the GitHub super-linter.\n\nTo run the linters locally, run the `run_super_linter.sh` bash script from the root directory.\n\n## UnitTest\n\nTest the software with the use of coverage:\n\n```bash\npython -m pip install --upgrade pip setuptools\npip install -r requirements.txt\npip install -e .\ncoverage run -m pytest\n```\n\n## Requirements\n\nRequirements are autogenerated by the `pip-compile` command with python 3.9\n\nInstall pip-tools with:\n\n```bash\npip install pip-tools\n```\n\nGenerate requirements.txt file with:\n\n```bash\npip-compile --extra=test --extra=lint --output-file=requirements.txt pyproject.toml\n```\n\nUpdate the requirements within the defined ranges with:\n\n```bash\npip-compile --upgrade --extra=test --extra=lint --output-file=requirements.txt pyproject.toml\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 CEMS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Controllers to create and modify Plaxis 2D and 3D models with enhanced functionalities.",
"version": "0.8.1",
"project_urls": {
"repository": "https://github.com/cemsbv/plxcontroller"
},
"split_keywords": [
"plxcontroller",
" cems",
" plaxis automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69b6e8c3d5217150aaf1ea33d04891c0e28fd2a36e6bd638d0629ce82507714e",
"md5": "1903ab4341f73cf92a20d992b05ae4c1",
"sha256": "4b26eecccc4581c6681b799effa1f5f40e7425bb1991f209eefc554560cedb0d"
},
"downloads": -1,
"filename": "plxcontroller-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1903ab4341f73cf92a20d992b05ae4c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17981,
"upload_time": "2024-10-31T22:54:55",
"upload_time_iso_8601": "2024-10-31T22:54:55.923143Z",
"url": "https://files.pythonhosted.org/packages/69/b6/e8c3d5217150aaf1ea33d04891c0e28fd2a36e6bd638d0629ce82507714e/plxcontroller-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63afc48cb643b2069c4780ab26be0afa90b305fb7e6e4cb46d3ca1d530d4dcd9",
"md5": "eb66b49ed9c6f9f8fddabe64708dc7d4",
"sha256": "f763fabd48e244ca722db4e0ddd213cdae7fdbcf1603fc906a0abab623095859"
},
"downloads": -1,
"filename": "plxcontroller-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "eb66b49ed9c6f9f8fddabe64708dc7d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14200,
"upload_time": "2024-10-31T22:54:57",
"upload_time_iso_8601": "2024-10-31T22:54:57.419850Z",
"url": "https://files.pythonhosted.org/packages/63/af/c48cb643b2069c4780ab26be0afa90b305fb7e6e4cb46d3ca1d530d4dcd9/plxcontroller-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 22:54:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cemsbv",
"github_project": "plxcontroller",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "plxcontroller"
}
