Skip to main content

A library for interacting with the HABS BrainOS API.

Project description

Binder

HABSlib

A Python library for interacting with the HABS BrainOS API, to manage EEG recordings, handling complexities like encryption, authentication, and more, so you can focus on building your application.

Please, consider reading (and providing feedback about) our online documentation.

Installation

You can install habslib using pip:

pip install HABSlib

Usage

Here’s a quick example to get you started:

import HABSlib as hb

###############
# Security handshake
hb.handshake(base_url="http://habs", user_id="your_id_from_habs")

###############
# Get user data by id
user_data = hb.get_user_by_id(user_id)
print(user_data)

# ###############
# Simple sending data
session_id = hb.acquire_send_raw(
    user_id=user_id, 
    date=datetime.today().strftime('%Y-%m-%d'), 
    board="SYNTHETIC",
    stream_duration=20, 
    buffer_duration=5
)
print("this session:", session_id)

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or need support, please open an issue on GitHub or contact dev@habs.ai.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

habslib-0.1.54.tar.gz (93.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

HABSlib-0.1.54-py3-none-any.whl (104.0 kB view details)

Uploaded Python 3

File details

Details for the file habslib-0.1.54.tar.gz.

File metadata

  • Download URL: habslib-0.1.54.tar.gz
  • Upload date:
  • Size: 93.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.6

File hashes

Hashes for habslib-0.1.54.tar.gz
Algorithm Hash digest
SHA256 3b681f5abfa264fc7bdb5db356f519bc8aef81da2789cbcc0e257012d6c9ab3c
MD5 ee6eae9aa8b2893206a8b4d7edfce17a
BLAKE2b-256 5d451dc18754982e8ea2c69efaf6f480fc634efb2e523b95783012074fe5c7dd

See more details on using hashes here.

File details

Details for the file HABSlib-0.1.54-py3-none-any.whl.

File metadata

  • Download URL: HABSlib-0.1.54-py3-none-any.whl
  • Upload date:
  • Size: 104.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.6

File hashes

Hashes for HABSlib-0.1.54-py3-none-any.whl
Algorithm Hash digest
SHA256 003ade77d1e5345fc36e3b4baf7c3a25c8947375f7eb29735b2f9667799cd3e5
MD5 5e687e1e4595576bf82b546517bc0ec6
BLAKE2b-256 7a2458085582702c9166a4e0ccef9e934dc1023a0dc347078d1b81da178c9b58

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page