Metadata-Version: 2.4
Name: saltext.sqlite3
Version: 1.0.0
Summary: Salt Extension for interacting with SQLite
Author-email: jeanluc <lkubb@protonmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/salt-extensions/saltext-sqlite3
Project-URL: Documentation, https://salt-extensions.github.io/saltext-sqlite/
Project-URL: Source, https://github.com/salt-extensions/saltext-sqlite3
Project-URL: Tracker, https://github.com/salt-extensions/saltext-sqlite3/issues
Keywords: salt-extension
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Provides-Extra: salt
Requires-Dist: salt>=3006; extra == "salt"
Dynamic: license-file

# Salt Extension for SQLite

Salt Extension for interacting with SQLite

## Security

If you discover a security vulnerability, please refer to
[Salt's security guide][security].

## User Documentation

For setup and usage instructions, please refer to the
[User Documentation][docs].

## Contributing

The saltext-sqlite3 project welcomes contributions from anyone!

The [Salt Extensions guide][salt-extensions-guide] provides
comprehensive instructions on all aspects of Salt extension
development, including [writing tests][writing-tests],
[running tests][running-tests], [writing documentation][writing-docs]
and [rendering the docs][rendering-docs].

### Quickstart

To get started contributing, first clone this repository (or your
fork):

```bash
# Clone the repo
git clone --origin upstream git@github.com:salt-extensions/saltext-sqlite3.git

# Change to the repo dir
cd saltext-sqlite3
```

#### Automatic

If you have installed [direnv], copying the included `.envrc.example`
to `.envrc` and allowing it to run ensures a proper development
environment is present and the virtual environment is active.

Without `direnv`, you can still run the automation explicitly:

```bash
make dev  # or python3 tools/initialize.py
source .venv/bin/activate
```

#### Manual

Please follow the [first steps][first-steps], skipping the repository
initialization and first commit.

### Pull request

Always make changes in a feature branch:

```bash
git switch -c my-feature-branch
```

Please ensure you include a
[news fragment](https://salt-extensions.github.io/salt-extension-copier/topics/documenting/changelog.html#procedure)
describing your changes. This is a requirement for all user-facing
changes (bug fixes, new features), with the exception of documentation
changes.

To [submit a Pull Request][submitting-pr], you'll need a fork of this
repository in your own GitHub account. If you followed the
instructions above, set your fork as the `origin` remote now:

```bash
git remote add origin git@github.com:<your_fork>.git
```

Ensure you followed the [first steps][first-steps] and commit your
changes, fixing any failing `pre-commit` hooks. Then push the feature
branch to your fork and submit a PR.

### Ways to contribute

Contributions come in many forms, and they’re all valuable! Here are
some ways you can help without writing code:

- **Documentation**: Especially examples showing how to use this
  project to solve specific problems.
- **Triaging issues**: Help manage [issues] and participate in
  [discussions].
- **Reviewing [Pull Requests][prs]**: We especially appreciate reviews
  using [Conventional Comments][comments].

You can also contribute by:

- Writing blog posts
- Sharing your experiences using Salt + SQLite on social media
- Giving talks at conferences
- Publishing videos
- Engaging in IRC, Discord or email groups

Any of these things are super valuable to our community, and we
sincerely appreciate every contribution!

[comments]: https://conventionalcomments.org/
[direnv]: https://direnv.net
[discussions]: https://github.com/salt-extensions/saltext-sqlite3/discussions
[docs]: https://salt-extensions.github.io/saltext-sqlite/
[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment
[issues]: https://github.com/salt-extensions/saltext-sqlite3/issues
[prs]: https://github.com/salt-extensions/saltext-sqlite3/pulls
[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html
[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html
[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html
[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html
