Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teiacare/teiacaresdk
TeiaCareSDK is a collection of reusable C++ components
https://github.com/teiacare/teiacaresdk
cpp cross-platform datetime geometry high-performance multithreading sdk utilities
Last synced: 4 days ago
JSON representation
TeiaCareSDK is a collection of reusable C++ components
- Host: GitHub
- URL: https://github.com/teiacare/teiacaresdk
- Owner: TeiaCare
- License: apache-2.0
- Created: 2024-03-08T09:26:38.000Z (8 months ago)
- Default Branch: develop
- Last Pushed: 2024-11-06T15:44:33.000Z (8 days ago)
- Last Synced: 2024-11-06T16:34:30.743Z (8 days ago)
- Topics: cpp, cross-platform, datetime, geometry, high-performance, multithreading, sdk, utilities
- Language: C++
- Homepage: https://teiacare.github.io/TeiaCareSDK/
- Size: 938 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# TeiaCareSDK
Welcome to TeiaCareSDK!
TeiaCareSDK is a collection of reusable C++ components.
[](https://teiacare.github.io/TeiaCareSDK/)
[](https://app.codacy.com/gh/TeiaCare/TeiaCareSDK/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.codacy.com/gh/TeiaCare/TeiaCareSDK/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
[](https://codecov.io/gh/TeiaCare/TeiaCareSDK)
## Key Features
* **Date & Time:** Master dates, times, and durations with ease using dedicated classes for manipulation, validation, formatting, conversions, timezones, and arithmetic operations.
* **Concurrency:** Take control of concurrent execution with thread-safe modules for managing tasks, queues, events, and thread pools, enabling efficient parallel processing.
* **Synchronization & Control:** Maintain data integrity and program flow with modules for rate limiting, observing data changes, and accurately measuring elapsed time, ensuring thread safety and coordinated execution.
* **Platform Agnostic:** Benefit from cross-platform compatibility with modules that adapt to your system's specifics, like version information, guaranteeing seamless code execution across different environments.
* **Singletons & Services:** Create and manage global instances effectively with a dedicated module, and organize your application logic with a service locator, achieving centralized access to essential services and a clean code structure.
* **Enhanced Code Safety:** Enforce best practices with base classes that prevent copying and moving objects, use a module to signal unexpected code paths, and leverage metaprogramming techniques for function analysis in unit testing, promoting robust and secure code.
* **Unique Identifier Generation:** Easily generate and manage Universally Unique Identifiers (UUIDs) with dedicated classes, allowing for effortless creation and tracking of unique identifiers for your entities.
* **Additional Utilities:** Discover more functionality with various modules like tasks, clocks, and observers, providing a broad spectrum of tools to address diverse development needs and enhance your applications.
## Why Choose TeiaCareSDK?
* **Modular Design:** Pick and choose the modules you need, keeping your project lean and focused.
* **Clear Documentation:** Comprehensive documentation with examples ensures smooth onboarding and understanding.
* **Active Community:** Engage with our community for support, feedback, and collaboration.
* **Tested & Reliable:** Enjoy peace of mind with well-tested and actively maintained code with mature CI/CD workflows.
* **Production Quality:** TeiaCareSDK runs in production environment serving thousands of devices on a daily basis.
## Supported Configurations
Azure DevOps build matrix is available [here](https://dev.azure.com/teiacare/TeiaCare/_build?definitionId=91&_a=summary).
| **OS** | **Compiler** | **Debug** | **Release** | **RelWithDebInfo** |
|----------------------|--------------------|:---------:|:-----------:|:------------------:|
| Windows Server 2022 | Visual Studio 2022 | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |[](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |
| Windows Server 2019 | Visual Studio 2019 | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |
| MacOS 14 Sonoma | Apple-Clang 15 | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |
| Ubuntu 22.04 | GCC 12 | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |
| Ubuntu 22.04 | Clang 15 | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) | [](https://dev.azure.com/teiacare/TeiaCare/_build/latest?definitionId=91&branchName=develop) |
| Ubuntu 24.04 | GCC 14 | 🚧 | 🚧 | 🚧 |
| Ubuntu 24.04 | Clang 18 | 🚧 | 🚧 | 🚧 |
## Try online on Wandbox
[](https://wandbox.org/permlink/sfU3VY4HFMBZp8QI)
```cpp
#include
#include "teiacare/sdk/observable.hpp"
int main()
{
auto callback = [](int value){ std::cout << "Update: " << value << "\n"; };
auto observable = tc::sdk::observable(-1, callback);
constexpr int total_updates = 10;
for (int i = 0; i < total_updates; ++i)
{
observable = i; // Trigger updates
}
return 0;
}
```
Check the [Examples](sdk/examples/src/) folder for an in-depth showcase of all the features of this library.
## Getting Started
This project uses git submodules so it is required to clone it using the *--recursive* flag in order to retrive the required submodules.
```bash
git clone https://github.com/TeiaCare/TeiaCareSDK.git --recursive
```
### Create Development Environment
In order to setup a development environment it is sufficient to run the script *scripts/env/setup.* depending on your operating system.
```bash
# Linux/MacOS
chmod +x scripts/env/setup.sh
scripts/env/setup.sh
# Windows
scripts\env\setup.bat
```
### Start Development Environment
In order to start the development environment it is sufficient to activate the Python Virtual Environment just created the step above.
```bash
# Linux/MacOS
source .venv/bin/activate
# Windows
.venv\Scripts\activate.bat
```
### Setup Build Environment (Windows Only)
When building from command line on Windows it is necessary to activate the Visual Studio Developer Command Prompt.
Depending on the version of Visual Studio compiler and on its install location it is required to run *vcvars64.bat* script the set the development environment properly.
*Note*: using Visual Studio IDE or the CMake extension for VSCode this step is already managed in the background, so no action is required.
Examples:
```bash
# Visual Studio 2022 - Build Tools
"C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build\vcvars64.bat"
# Visual Studio 2019 - Enterprise
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
```
### Setup Dependencies
This script must be executed in order to install the 3rd party dependencies specified in the conanfile (note that 3rd party libs are only required for unit tests, examples and benchmarks).
See the section [Scripts Parameters](#scripts-parameters) for more details on the allowed scripts parameters.
```bash
python scripts/conan/setup.py
# examples:
python scripts/conan/setup.py Debug visual_studio 17
python scripts/conan/setup.py Release clang 15
```
### Configure, Build and Install
This script configures, builds and installs the library.
```bash
python scripts/cmake.py
```
## Examples
```bash
# Build all the examples
python scripts/cmake.py --examples --warnings
# Run all the examples
python3 scripts/tools/run_examples.py install/examples
```
Examples are installed in $PWD/install/examples.
## Unit Tests and Code Coverage
```bash
# Build Unit Tests with Code Coverage enabled (if supported)
python scripts/cmake.py --coverage --warnings
# Run Unit Tests
python scripts/tools/run_unit_tests.py
# Run Code Covergae
python scripts/tools/run_coverage.py sdk --extra_args=-e=sdk/src/datetime/date.h
```
Note that code coverage is not available on Windows.
Unit tests results are available in $PWD/results/unit_tests.
Coverage results are available in $PWD/results/coverage.
## Benchmarks
```bash
python scripts/cmake.py --benchmarks --warnings
python scripts/tools/run_benchmarks.py
```
Benchmarks are installed in $PWD/install/benchmarks.
## Code Formatting
[clang-format](https://clang.llvm.org/docs/ClangFormat.html)
*clang-format* can be installed via *pip* using the provided *scripts/requirements.txt*
```bash
python scripts/tools/run_clang_format.py sdk
```
## Code Analysis
[clang-tidy](https://clang.llvm.org/extra/clang-tidy/)
*clang-tidy* can be installed via *pip* using the provided *scripts/requirements.txt*
```bash
python scripts/tools/run_clang_tidy.py -header-filter=.* sdk
```
[cppcheck](http://cppcheck.net/)
First install and setup *cppcheck* from your OS package manager.
```bash
# Linux
sudo apt install cppcheck
# Windows
winget install cppcheck
```
Then run CppCheck using the provided python script:
```bash
python scripts/tools/run_cppcheck.py
```
## Generate Documentation
First install and setup *Doxygen* from your OS package manager.
```bash
# Linux
apt-get install doxygen graphviz
# Windows
winget install doxygen
```
Then run Doxygen using the provided python script:
```bash
python scripts/tools/run_doxygen.py
```
Documentation is now installed in $PWD/docs.
## Conan Package
### Local Install
Create, test and install local package.
Notes:
1) The install directory path must be a valid Conan cache (i.e. ".conan" folder) located in the current directory.
So, in order to install the package in a desired repository folder, it is required to run this script from the repository folder directly.
2) The Conan package tests are automatically run during package creation.
The directory test_package contains a test project that is built to validate the proper package creation.
```bash
# Create the Conan package locally
python scripts/conan/create.py
# Build and install the test package executable
python test_package/build.py
# Run the test package executable
$PWD/install/test_package/teiacare_sdk_test_package
```
### Artifactory Upload
In order to upload a Conan package to TeiaCare Artifactory server it is required to setup you local Conan client once with the following commands:
```bash
# Add TeiaCare Artifactory remote to local Conan client
conan remote add teiacare $(artifactory.url)/teiacare
# Authenticate with Artifactory credentials
conan user $(artifactory.username) -p $(artifactory.password) -r teiacare
```
Now it is possible to create and upload a Conan package with the following commands:
```bash
# Create the Conan package locally
python scripts/conan/create.py
# Upload the package to Artifactory on the teicare remote
python scripts/conan/upload.py teiacare teiacare_sdk/@
```
## Contributing
In order to contribute to TeiaCareSDK, please follow our [contribution guidelines](./CONTRIBUTING).
[](./CONTRIBUTING)
## License
This project is licensed under the [Apache License, Version 2.0](./LICENSE).
[](./LICENSE)
Copyright © 2024 [TeiaCare](https://teiacare.com/)