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.53.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.53-py3-none-any.whl (104.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: habslib-0.1.53.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.53.tar.gz
Algorithm Hash digest
SHA256 a157d2eacc83b0f24fd7a3a4b36e5b09121d2f3eb88e6ae134d09f127db89022
MD5 34eb4cb97815c9595271539be2348599
BLAKE2b-256 c25ab8900d43a44fa73c9a4e49f313c1f3faed6a893f160788d99786a9b20fe2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: HABSlib-0.1.53-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.53-py3-none-any.whl
Algorithm Hash digest
SHA256 0d2378cd049a4a037e364826369898449dfcc6c2468b6e789578ff221b5af44e
MD5 840a412263b62de62512f61b11eedc6a
BLAKE2b-256 859c4d50ab21c2f4053dd89aad7bc3aad07fc9fe0a30ca78efcec67f18098e91

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