Skip to content

This is a C++ library for the GitHub API compatible with Arduino and ESP32 microcontrollers

License

Notifications You must be signed in to change notification settings

aeonSolutions/AeonLabs-GitHub-API-C-library

Repository files navigation

Donate Say Thanks trackgit-views

Navigation | AeonLabs Main Index >> Main Page - Open Source Code Software >> GitHub API C library

Goto Open Science Research   Last update 28-09-2024
Change Language

CodeFactor GitHub API C++ library

current project Total: > 50 work.h
current version: 0.5

I start working again on this project beginning next year 2025. In the meantime looking for sponsors to pay for the required work necessary for the successful completion of this project.

I have also available here, on Github, a C++ library for the Dataverse API (data repositories). To view click here.

This is a C++-based library intended for embedded firmware development, however, it can be easily ported and made compatible with any platform or operating system. see the WIKI for more information.


GitHub is a web-based platform designed for version control and collaborative software development. It allows developers to manage and track changes to their code using Git, a version control system. With GitHub, multiple contributors can work on a project simultaneously, making it easy to collaborate, review, and integrate changes. It also provides features like issue tracking, pull requests, and code reviews, facilitating streamlined teamwork and ensuring code integrity over time. Additionally, GitHub hosts millions of open-source projects, allowing users to share and contribute to global software development.

The Official GitHub chat: https://github.com/orgs/community/discussions

Test the API
There's a test code .ino file available for Arduino-compatible microcontrollers, such as EspressIF's ESP32, to test connectivity with a dataverse API. Link to the code:
https://github.com/aeonSolutions/Aeonlabs-Arduino_Hardware_Test_Code/tree/main/github_api_test_upload

GitHub API in another coding language


Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aeonSolutions/Aeonlabs-Arduino_Hardware_Test_Code/tree/main/github_api_test_upload.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct. Don't forget to read AeonLabs's Wiki before using any code or electronics available here on Github. Thank you.


Coding standards

Please make sure tests pass before committing, and to add new tests for new additions.


Instalation & usage

To learn how to install and use this library, goto the wiki page here or by clicking on the top menu.

There's an ongoing research project to develop a "Proof of Concept of a Smart DAQ Device able to Upload Live Experimental Sensor Data to a Data Repository with a Unique Data Fingerprint" that discusses an innovative proof-of-concept method for management of collected experimental data in real-time and compatible with any open environment. The proposed proof-of-concept smart DAQ device has the minimum hardware characteristics to handle data measurements collection from sensors locally connected to it, store it on a local CSV or SQLite database file and finally connect and synchronize data measurements collected with a data repository hosted remotely on a Dataverse.


For more general information

Ask a question or start a discussion: A great place to publicly share feedback, ideas, feature requests, and troubleshoot any issues is in the GitHub Users Community.

For Developers

The GitHub REST API documentation can be found here: https://docs.github.com/en/rest


Academic Credit & Best Practices

By depositing data into a GitHub repository, which can be customized or embedded into a website with GitHub's Theme + Widgets feature, researchers make their datasets more discoverable to the scientific community.

By increasing research data's visibility with GitHub, researchers can get recognition and academic credit for their scholarly work through a data citation. These citations also help ensure that when research data is published, funder and publisher requirements are met, and data is reused by other scholars, replicated for verification, and tracked to measure usage and impact over time, which can help fund future research.

A data citation in a GitHub repository is required to have the following components:

  • author name(s)
  • year (date published in the GitHub repository)
  • title
  • global persistent identifier: DOI or Handle
  • publisher (repository that published the dataset)
  • version number
  • universal numerical fingerprint (UNF): for tabular data

Here is an example of a replication data citation from Political Analysis, Hanmer, Banks, and White, 2013:

Hanmer, Michael J.; Banks, Antoine J., White, Ismail K., 2013, "Replication data for: Experiments to Reduce the Over-reporting of Voting: A Pipeline to the Truth", doi:10.7910/DVN/22893, Harvard Dataverse, V2, UNF:5:eJOVAjDU0E0jzSQ2bRCg9g==

See more detailed information about Data Citation Standard.


Library API Implementation Progress


Wiki? Endpoint Description Implemented? Notes
PUSH Files -
- GET SHA Blob of a File Y -
- PUSH File in chunks Y -


Author

You can get in touch with me on my LinkedIn Profile:

Miguel Tomas

LinkedIn Link

You can also follow my GitHub Profile to stay updated about my latest projects: GitHub Follow


Be supportive of my dedication and work towards technology education and buy me a cup of coffee

The PCB Design Files I provide here for anyone to use are free. If you like this Smart Device or use it, please consider buying me a cup of coffee, a slice of pizza or a book to help me study, eat and think new PCB design files.



License

Before proceeding to download any of AeonLab's open-source code for software solutions and/or open hardware electronics for smart devices and data acquisition make sure you are choosing the right license for your project. See AeonLabs Solutions for Open Hardware & Open Source Code for more information. For commercial business solutions contact AeonLabs ℹ️ using the contacts above. Thank you 🙏.

About

This is a C++ library for the GitHub API compatible with Arduino and ESP32 microcontrollers

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages