semvec/pypi-packages huggingface dataset:
dataconf_dbx 0.0.2
Dataconf adapter for reading configurations from Databricks dbutils.
Requires Python: <4.0,>=3.8

# dataconf-dbx

[![Release](https://img.shields.io/github/v/release/Shlomigreen/dataconf-dbx)](https://img.shields.io/github/v/release/Shlomigreen/dataconf-dbx)
[![Build status](https://img.shields.io/github/actions/workflow/status/Shlomigreen/dataconf-dbx/main.yml?branch=main)](https://github.com/Shlomigreen/dataconf-dbx/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/Shlomigreen/dataconf-dbx/branch/main/graph/badge.svg)](https://codecov.io/gh/Shlomigreen/dataconf-dbx)
[![Commit activity](https://img.shields.io/github/commit-activity/m/Shlomigreen/dataconf-dbx)](https://img.shields.io/github/commit-activity/m/Shlomigreen/dataconf-dbx)
[![License](https://img.shields.io/github/license/Shlomigreen/dataconf-dbx)](https://img.shields.io/github/license/Shlomigreen/dataconf-dbx)

Dataconf adapter for reading configurations from Databricks dbutils.

- **Github repository**: <https://github.com/Shlomigreen/dataconf-dbx/>
- **Documentation** <https://Shlomigreen.github.io/dataconf-dbx/>

## Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:Shlomigreen/dataconf-dbx.git
git push -u origin main
```

Finally, install the environment and the pre-commit hooks with

```bash
make install
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).

## Releasing a new version

- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/Shlomigreen/dataconf-dbx/settings/secrets/actions/new).
- Create a [new release](https://github.com/Shlomigreen/dataconf-dbx/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
edgegap-fixtures 1.0.0
The Edgegap Fixtures library includes various tools and helpers for interacting with Pytest Fixtures
Requires Python: <4.0,>=3.10

# Edgegap Fixtures Library

This is the README for the Edgegap Pytest Fixtures, which is part of the Edgegap suite of helpers.
This library provides utilities for interacting with pytest to mock elements like consul, database, etc.

## Table of Contents

- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [Running Tests](#running-tests)
- [Uploading Package](#uploading-package)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

The Edgegap Fixtures library includes various tools and helpers for interacting with Pytest Fixtures.
It is designed for use within the Edgegap organization.

## Installation

To install this library, ensure you have Python and `poetry` installed. Then, use the following command:

```bash
poetry add edgegap-logging
```

Ensure you have the necessary permissions to install and use this library, as it is intended for Edgegap employees only.

## Usage

Please consult Obsidian Documentation for Usage

## Running Tests

To run tests for this library, you need to have pytest installed. You can install dev dependencies with:

```bash
poetry install --with=dev
```

then run

```bash
pytest
```

This will execute all the tests in the tests folder.

## Uploading Package

To upload the distribution to pypi, you will need an API token from Pypi

```bash
poetry config pypi-token.pypi <your-api-token>
poetry version x.x.x
poetry publish --build
```

## Contributing

If you'd like to contribute to this library and you're an Edgegap employee, please follow these steps:

- Fork the repository.
- Create a new branch for your changes (e.g., feature/my-feature).
- Commit your changes with a clear message.
- Push your branch to your fork.
- Open a Pull Request, explaining the changes and providing any necessary context.

## License

This software is proprietary to Edgegap. Only current Edgegap employees are allowed to use this library. Refer to the
LICENSE file for detailed licensing information.

## Contact

For support or questions related to this library, please contact support@edgegap.com.

## Acknowledgements

Thanks to the Edgegap development team for creating and maintaining this library.