| Name | pycatia JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | https://github.com/evereux/pycatia |
| Summary | A python module to interface with the CATIA V5 COM object. |
| upload_time | 2024-08-26 12:57:36 |
| maintainer | None |
| docs_url | None |
| author | Paul Bourne |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. _pycatia.readthedocs.io: https://pycatia.readthedocs.io
.. _installation: https://pycatia.readthedocs.io/en/latest/installation.html
.. _introduction: https://pycatia.readthedocs.io/en/latest/introduction.html
.. _examples: https://pycatia.readthedocs.io/en/latest/examples.html
.. _user_scripts: https://pycatia.readthedocs.io/en/latest/user_scripts.html
.. _pypi.org: https://pypi.org/project/pycatia/
.. _pycatia-tools: https://github.com/evereux/pycatia-tools
pycatia
=======
alpha software
--------------
This is alpha software.
All the test cases and examples work but there will be many issues outside of
the test framework. The CATIA com interface is large and I've predominantly
wrote tests for those areas I'm familiar. Any bugs that exist should be for the
most part be quite easy to fix using those methods that do work as a reference.
I have limited access to CATIA licences / workbenches. Also, there are many
modules that I simply don't know what they do. Thus my ability to test and
support can be limited.
Any bugs that exist should be for the most part be quite easy to
fix using those methods that do work as a reference.
Requirements
------------
* python >= 3.9
* **CATIA V5** running on Windows.
* see requirements.txt
Installation
------------
see installation_.
Usage
-----
See the introduction_, examples_ and user_scripts_ for a good over view on how
to use pycatia.
Links
-----
Releases: pycatia @ pypi.org_
Examples And Scripts
--------------------
See the documentation @ examples_ and user_scripts_.
A GUI based application that uses pycatia - pycatia-tools_.
Asking Questions
----------------
Please read the following with regards to raising questions: https://github.com/evereux/pycatia/issues/28
Contributing
------------
See CONTRIBUTING.md in root of github repository.
Running The Tests
-----------------
Prior to running the tests please ensure CATIA V5 has the following
configuration settings:
* CGR cache system must be disabled.
* Do not activate default shapes on open must be disabled.
* Parameter names must not have back ticks enabled. Tools > Options > General > Parameters and Measure > Knowledge > Parameter Names > Surrounded by the \` symbol.
On the first run, during the running of the tests, the test suite will create
the CATIA drawing, products and part it requires to run in the folder
tests/cat_files.
CATIA V5 should already be running and have NO documents already open.
To run the tests with coverage (-v is verbosity):
.. code-block:: python
py.test -v --cov-report term-missing --cov=pycatia
To run a specific test:
.. code-block:: python
py.test -v tests/test_product.py::test_move
To stop tests running after first failure.
py.test -vx
Release process
---------------
A reminder for @evereux. I don't do this often and forget ...
* Check version is correct.
* Check changelog has been updated.
* Run the tests. `pytest -v tests`
* Ensure cache is disabled and
* Fix any issues.
* Run the examples.
* Fix any issues.
* Build the docs. `cd docs` `./make html`
* Fix any issues.
* Run mypy over module. `mypy pycatia`
* Build source. ``python setup.py sdist bdist_wheel``
* Check source contents.
* Build pycatia exe ``python -m nuitka --standalone pycatia-exe.py``.
* use 64 env.
* rename pycatia-exe.exe.
* Merge changes with master branch and upload.
* Upload to pypi. ``twine upload dist/*``.
* Update github releases.
Raw data
{
"_id": null,
"home_page": "https://github.com/evereux/pycatia",
"name": "pycatia",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Paul Bourne",
"author_email": "evereux@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/33/dd/188bb057848744564d54fe8ea0d6172431b280d4ecaa32c0f91990b07526/pycatia-0.8.0.tar.gz",
"platform": null,
"description": ".. _pycatia.readthedocs.io: https://pycatia.readthedocs.io\r\n.. _installation: https://pycatia.readthedocs.io/en/latest/installation.html\r\n.. _introduction: https://pycatia.readthedocs.io/en/latest/introduction.html\r\n.. _examples: https://pycatia.readthedocs.io/en/latest/examples.html\r\n.. _user_scripts: https://pycatia.readthedocs.io/en/latest/user_scripts.html\r\n.. _pypi.org: https://pypi.org/project/pycatia/\r\n.. _pycatia-tools: https://github.com/evereux/pycatia-tools\r\n\r\npycatia\r\n=======\r\n\r\nalpha software\r\n--------------\r\n\r\nThis is alpha software.\r\n\r\nAll the test cases and examples work but there will be many issues outside of\r\nthe test framework. The CATIA com interface is large and I've predominantly\r\nwrote tests for those areas I'm familiar. Any bugs that exist should be for the\r\nmost part be quite easy to fix using those methods that do work as a reference.\r\n\r\nI have limited access to CATIA licences / workbenches. Also, there are many\r\nmodules that I simply don't know what they do. Thus my ability to test and\r\nsupport can be limited.\r\n\r\nAny bugs that exist should be for the most part be quite easy to\r\nfix using those methods that do work as a reference.\r\n\r\n\r\nRequirements\r\n------------\r\n\r\n* python >= 3.9\r\n* **CATIA V5** running on Windows.\r\n* see requirements.txt\r\n\r\nInstallation\r\n------------\r\n\r\nsee installation_.\r\n\r\n\r\nUsage\r\n-----\r\n\r\nSee the introduction_, examples_ and user_scripts_ for a good over view on how\r\nto use pycatia.\r\n\r\n\r\nLinks\r\n-----\r\n\r\nReleases: pycatia @ pypi.org_\r\n\r\n\r\nExamples And Scripts\r\n--------------------\r\n\r\nSee the documentation @ examples_ and user_scripts_.\r\n\r\nA GUI based application that uses pycatia - pycatia-tools_.\r\n\r\n\r\nAsking Questions\r\n----------------\r\n\r\nPlease read the following with regards to raising questions: https://github.com/evereux/pycatia/issues/28\r\n\r\n\r\nContributing\r\n------------\r\n\r\nSee CONTRIBUTING.md in root of github repository.\r\n\r\n\r\nRunning The Tests\r\n-----------------\r\n\r\nPrior to running the tests please ensure CATIA V5 has the following\r\nconfiguration settings:\r\n\r\n* CGR cache system must be disabled.\r\n* Do not activate default shapes on open must be disabled.\r\n* Parameter names must not have back ticks enabled. Tools > Options > General > Parameters and Measure > Knowledge > Parameter Names > Surrounded by the \\` symbol.\r\n\r\nOn the first run, during the running of the tests, the test suite will create\r\nthe CATIA drawing, products and part it requires to run in the folder\r\ntests/cat_files.\r\n\r\nCATIA V5 should already be running and have NO documents already open.\r\n\r\nTo run the tests with coverage (-v is verbosity):\r\n\r\n.. code-block:: python\r\n\r\n py.test -v --cov-report term-missing --cov=pycatia\r\n\r\nTo run a specific test:\r\n\r\n.. code-block:: python\r\n\r\n py.test -v tests/test_product.py::test_move\r\n\r\nTo stop tests running after first failure.\r\n\r\n py.test -vx\r\n\r\nRelease process\r\n---------------\r\n\r\nA reminder for @evereux. I don't do this often and forget ...\r\n\r\n* Check version is correct.\r\n\r\n* Check changelog has been updated.\r\n\r\n* Run the tests. `pytest -v tests`\r\n * Ensure cache is disabled and\r\n * Fix any issues.\r\n\r\n* Run the examples.\r\n * Fix any issues.\r\n\r\n* Build the docs. `cd docs` `./make html`\r\n * Fix any issues.\r\n\r\n* Run mypy over module. `mypy pycatia`\r\n\r\n* Build source. ``python setup.py sdist bdist_wheel``\r\n * Check source contents.\r\n\r\n* Build pycatia exe ``python -m nuitka --standalone pycatia-exe.py``.\r\n * use 64 env.\r\n * rename pycatia-exe.exe.\r\n\r\n* Merge changes with master branch and upload.\r\n\r\n* Upload to pypi. ``twine upload dist/*``.\r\n\r\n* Update github releases.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A python module to interface with the CATIA V5 COM object.",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://github.com/evereux/pycatia"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f277cd19ce4a4d5b193ab69b9f6f06bf86972fa52619ef34ed1efad088bd80d5",
"md5": "a92f38a0e020c735791ea5e21078dc29",
"sha256": "ff072f7534eadd63d50d3949ef17f8cb5f2b312304a452f12eb59be5672d7b40"
},
"downloads": -1,
"filename": "pycatia-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a92f38a0e020c735791ea5e21078dc29",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2447210,
"upload_time": "2024-08-26T12:57:31",
"upload_time_iso_8601": "2024-08-26T12:57:31.977035Z",
"url": "https://files.pythonhosted.org/packages/f2/77/cd19ce4a4d5b193ab69b9f6f06bf86972fa52619ef34ed1efad088bd80d5/pycatia-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33dd188bb057848744564d54fe8ea0d6172431b280d4ecaa32c0f91990b07526",
"md5": "bdf60651132a9a464700839428cdc812",
"sha256": "2e161ed5a3296943826100e644763a1d386f136336edd462d06deee025c4e6e8"
},
"downloads": -1,
"filename": "pycatia-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "bdf60651132a9a464700839428cdc812",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1362140,
"upload_time": "2024-08-26T12:57:36",
"upload_time_iso_8601": "2024-08-26T12:57:36.558525Z",
"url": "https://files.pythonhosted.org/packages/33/dd/188bb057848744564d54fe8ea0d6172431b280d4ecaa32c0f91990b07526/pycatia-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 12:57:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "evereux",
"github_project": "pycatia",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pycatia"
}
