# Neuracore Python Client
Neuracore is a powerful robotics and machine learning client library for seamless robot data collection, model deployment, and interaction.
## Features
- Easy robot initialization and connection
- Streaming data logging
- Model endpoint management
- Local and remote model support
- Flexible dataset creation
## Installation
```bash
pip install neuracore
```
## Quick Start
Ensure you have an account at [neuracore.app](https://www.neuracore.app/)
### Authentication
```python
import neuracore as nc
# This will save your API key locally
nc.login()
```
### Robot Connection
```python
# Connect to a robot
nc.connect_robot(
robot_name="MyRobot",
urdf_path="/path/to/robot.urdf"
)
```
### Data Logging
```python
# Log joint positions
nc.log_joints({
'joint1': 0.5,
'joint2': -0.3
})
# Log RGB camera image
nc.log_rgb("top_camera", image_array)
```
## Development
To set up for development:
```bash
git clone https://github.com/neuraco/neuracore
cd neuracore
pip install -e .[dev]
```
## Testing
```bash
export NEURACORE_API_URL=http://localhost:8000/api
pytest tests/
```
## Contributing
Contributions are welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/neuraco/neuracore",
"name": "neuracore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "robotics machine-learning ai client-library",
"author": "Stephen James",
"author_email": "stephen@neuraco.com",
"download_url": "https://files.pythonhosted.org/packages/b6/ec/b9bf78b8d29e2acbb14c4f3f83bbf253f50c3b47ac3e6ed53cf905416fab/neuracore-1.0.2.tar.gz",
"platform": null,
"description": "# Neuracore Python Client\n\nNeuracore is a powerful robotics and machine learning client library for seamless robot data collection, model deployment, and interaction.\n\n## Features\n\n- Easy robot initialization and connection\n- Streaming data logging\n- Model endpoint management\n- Local and remote model support\n- Flexible dataset creation\n\n## Installation\n\n```bash\npip install neuracore\n```\n\n## Quick Start\n\nEnsure you have an account at [neuracore.app](https://www.neuracore.app/)\n\n### Authentication\n\n```python\nimport neuracore as nc\n\n# This will save your API key locally\nnc.login()\n```\n\n### Robot Connection\n\n```python\n# Connect to a robot\nnc.connect_robot(\n robot_name=\"MyRobot\", \n urdf_path=\"/path/to/robot.urdf\"\n)\n```\n\n### Data Logging\n\n```python\n# Log joint positions\nnc.log_joints({\n 'joint1': 0.5, \n 'joint2': -0.3\n})\n\n# Log RGB camera image\nnc.log_rgb(\"top_camera\", image_array)\n```\n\n## Development\n\nTo set up for development:\n\n```bash\ngit clone https://github.com/neuraco/neuracore\ncd neuracore\npip install -e .[dev]\n```\n\n## Testing\n\n```bash\nexport NEURACORE_API_URL=http://localhost:8000/api\npytest tests/\n```\n\n## Contributing\n\nContributions are welcome!\n",
"bugtrack_url": null,
"license": null,
"summary": "Neuracore Client Library",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/neuraco/neuracore"
},
"split_keywords": [
"robotics",
"machine-learning",
"ai",
"client-library"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "77e67c5cbe4e5344f3600754e21a373b7124fb8e41b7092f966715189b201192",
"md5": "6f00f0018d4e395a3397d23165056c74",
"sha256": "9758850d5c982e8682cafbd8610788173f22e2e659d82dfa01dd9e9c408e63e4"
},
"downloads": -1,
"filename": "neuracore-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f00f0018d4e395a3397d23165056c74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17892,
"upload_time": "2025-01-22T14:39:45",
"upload_time_iso_8601": "2025-01-22T14:39:45.869543Z",
"url": "https://files.pythonhosted.org/packages/77/e6/7c5cbe4e5344f3600754e21a373b7124fb8e41b7092f966715189b201192/neuracore-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b6ecb9bf78b8d29e2acbb14c4f3f83bbf253f50c3b47ac3e6ed53cf905416fab",
"md5": "5cc8d2e8b7637c18dc9961b58633ac06",
"sha256": "a828c5820f65e227897d02f569f5aae6d62cec8f0a7f11015d57e6ef821945f2"
},
"downloads": -1,
"filename": "neuracore-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "5cc8d2e8b7637c18dc9961b58633ac06",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15415,
"upload_time": "2025-01-22T14:39:47",
"upload_time_iso_8601": "2025-01-22T14:39:47.243339Z",
"url": "https://files.pythonhosted.org/packages/b6/ec/b9bf78b8d29e2acbb14c4f3f83bbf253f50c3b47ac3e6ed53cf905416fab/neuracore-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 14:39:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neuraco",
"github_project": "neuracore",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neuracore"
}