| Name | openc3 JSON |
| Version |
6.0.2
JSON |
| download |
| home_page | None |
| Summary | Python support for OpenC3 COSMOS |
| upload_time | 2025-01-09 21:19:52 |
| maintainer | None |
| docs_url | None |
| author | Support |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Python support for OpenC3 COSMOS v5
---
This project allows accessing the COSMOS v5 API from the python programming language.
Additional functionality and support will be added over time.
---
[](https://github.com/psf/black)
## Installation:
```
pip install openc3
```
See the docs, examples for usage
## Create a Virtual Python Environment
`cd` to your project directory and run `virtualenv` to create the new virtual environment.
The following commands will create a new virtual environment under `openc3/venv`.
```
cd openc3
py -m pip install venv
py -m venv venv
```
### Activate the Environment
Now that we have a virtual environment, we need to activate it.
```
.\venv\Scripts\activate
```
After you activate the environment, your command prompt will be modified to reflect the change.
### Development requirements-dev.txt
Although requests is required, when doing development work it is helpful to test with pytest, use black, and coverage. These can be found in `requirements-dev.txt`
```
> py -m pip install -r requirements-dev.txt
```
### Add Libraries and Create a requirements.txt File
After you activate the virtual environment, you can add packages to it using `pip`. You can also create a description of your dependencies using `pip`.
The following command creates a file called `requirements.txt` that enumerates the installed packages.
```
py -m pip freeze > requirements.txt
```
This file can then be used by collaborators to update virtual environments using the following command.
```
py -m pip install -r requirements.txt
```
### Deactivate the Environment
To return to normal system settings, use the deactivate command.
```
deactivate
```
After you issue this command, you’ll notice that the command prompt returns to normal.
Raw data
{
"_id": null,
"home_page": null,
"name": "openc3",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Support",
"author_email": "support@openc3.com",
"download_url": "https://files.pythonhosted.org/packages/de/de/0fe9f628c4f328639a5e632e129e37cd9e6c5a50a0971ff68fe687585628/openc3-6.0.2.tar.gz",
"platform": null,
"description": "## Python support for OpenC3 COSMOS v5\n\n---\n\nThis project allows accessing the COSMOS v5 API from the python programming language.\nAdditional functionality and support will be added over time.\n\n---\n\n[](https://github.com/psf/black)\n\n## Installation:\n\n```\npip install openc3\n```\n\nSee the docs, examples for usage\n\n## Create a Virtual Python Environment\n\n`cd` to your project directory and run `virtualenv` to create the new virtual environment.\n\nThe following commands will create a new virtual environment under `openc3/venv`.\n\n```\ncd openc3\npy -m pip install venv\npy -m venv venv\n```\n\n### Activate the Environment\n\nNow that we have a virtual environment, we need to activate it.\n\n```\n.\\venv\\Scripts\\activate\n```\n\nAfter you activate the environment, your command prompt will be modified to reflect the change.\n\n### Development requirements-dev.txt\n\nAlthough requests is required, when doing development work it is helpful to test with pytest, use black, and coverage. These can be found in `requirements-dev.txt`\n\n```\n> py -m pip install -r requirements-dev.txt\n```\n\n### Add Libraries and Create a requirements.txt File\n\nAfter you activate the virtual environment, you can add packages to it using `pip`. You can also create a description of your dependencies using `pip`.\n\nThe following command creates a file called `requirements.txt` that enumerates the installed packages.\n\n```\npy -m pip freeze > requirements.txt\n```\n\nThis file can then be used by collaborators to update virtual environments using the following command.\n\n```\npy -m pip install -r requirements.txt\n```\n\n### Deactivate the Environment\n\nTo return to normal system settings, use the deactivate command.\n\n```\ndeactivate\n```\n\nAfter you issue this command, you\u2019ll notice that the command prompt returns to normal.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python support for OpenC3 COSMOS",
"version": "6.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80cd7d0cab0ab99b47e2353bfa8c4728769611d16e27e3f8c0e32b07e09c4766",
"md5": "fc2d647d3b865c169a415ae66dce8039",
"sha256": "3c19240d05bafe13766c1f0e8d59b797a2fc7435f7e13d2eb8ec0dcfd7fa7988"
},
"downloads": -1,
"filename": "openc3-6.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc2d647d3b865c169a415ae66dce8039",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 390771,
"upload_time": "2025-01-09T21:19:49",
"upload_time_iso_8601": "2025-01-09T21:19:49.912116Z",
"url": "https://files.pythonhosted.org/packages/80/cd/7d0cab0ab99b47e2353bfa8c4728769611d16e27e3f8c0e32b07e09c4766/openc3-6.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dede0fe9f628c4f328639a5e632e129e37cd9e6c5a50a0971ff68fe687585628",
"md5": "fb004737189207fdfae6d962beb57f29",
"sha256": "43b55cca9dbef4d5798c684d746c56f67dcbd93e4f92127ef853e6584a24802a"
},
"downloads": -1,
"filename": "openc3-6.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fb004737189207fdfae6d962beb57f29",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 242583,
"upload_time": "2025-01-09T21:19:52",
"upload_time_iso_8601": "2025-01-09T21:19:52.483777Z",
"url": "https://files.pythonhosted.org/packages/de/de/0fe9f628c4f328639a5e632e129e37cd9e6c5a50a0971ff68fe687585628/openc3-6.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-09 21:19:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openc3"
}
