## 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
Althought 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": "https://github.com/OpenC3/cosmos",
"name": "openc3",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "openc3 cosmos",
"author": "Ryan Melton",
"author_email": "ryan@openc3.com",
"download_url": "https://files.pythonhosted.org/packages/0f/ba/c218977c9f296ddbef9348051ef3ce9f7d6afd3c82c5233e4fa6b79de41f/openc3-5.16.1.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\nAlthought 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",
"bugtrack_url": null,
"license": "AGPLv3, Nonstandard",
"summary": "Python Support for OpenC3 COSMOS v5",
"version": "5.16.1",
"project_urls": {
"Homepage": "https://github.com/OpenC3/cosmos"
},
"split_keywords": [
"openc3",
"cosmos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c411e97c08fb5a8bcd7978999fb42feb24d9e8709afc60610448e4028f71b8d7",
"md5": "9a1c98e990041405b0fe2cbabaa82b1e",
"sha256": "6791c8507906cf9ad190465adb60fb5752010e3eb2cdad3c46cf126ffbe583b5"
},
"downloads": -1,
"filename": "openc3-5.16.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a1c98e990041405b0fe2cbabaa82b1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 539735,
"upload_time": "2024-05-09T03:31:13",
"upload_time_iso_8601": "2024-05-09T03:31:13.039052Z",
"url": "https://files.pythonhosted.org/packages/c4/11/e97c08fb5a8bcd7978999fb42feb24d9e8709afc60610448e4028f71b8d7/openc3-5.16.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fbac218977c9f296ddbef9348051ef3ce9f7d6afd3c82c5233e4fa6b79de41f",
"md5": "de7496c4c566af50cabc9da58827bcd2",
"sha256": "219f345fc08873d13845ebe83fa9f33152a46996d42809fed397e207916d7c57"
},
"downloads": -1,
"filename": "openc3-5.16.1.tar.gz",
"has_sig": false,
"md5_digest": "de7496c4c566af50cabc9da58827bcd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 350606,
"upload_time": "2024-05-09T03:31:15",
"upload_time_iso_8601": "2024-05-09T03:31:15.319321Z",
"url": "https://files.pythonhosted.org/packages/0f/ba/c218977c9f296ddbef9348051ef3ce9f7d6afd3c82c5233e4fa6b79de41f/openc3-5.16.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 03:31:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenC3",
"github_project": "cosmos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openc3"
}
JSON
