From f7cb6fd089d85f812ce87ce7dc60220ad607f2d2 Mon Sep 17 00:00:00 2001
From: xmnlab Envers is a tool for handling environment files (e.g. .env) for multiple kind of environments with versioning The security of our code: Bandit is a powerful tool that we use in our Python project to ensure its security. This tool analyzes the code and detects potential vulnerabilities. Some of the key features of Bandit are its ease of use, its ability to integrate with other tools, and its support for multiple Python versions. If you want to know about bandit you can check its documentation. Finds unused code: Vulture is useful for cleaning up and finding errors in large code bases in Python. Complexity of functions and modules: We use McCabe to identify the complexity in our Python code that may be difficult to maintain or understand. By identifying complex code at the outset, we as developers can refactor it to make it easier to maintain and understand. In summary, McCabe helps us to improve the quality of our code and make it easier to maintain. If you would like to learn more about McCabe and code complexity, you can visit McCabe - Code Complexity Checker. This tool is included with Flake8. TODO This package was created with Cookieninja and the osl-incubator/scicookie project template. In order to be able to contribute, it is important that you understand the project layout. This project uses the src layout, which means that the package code is located at For my information, check the official documentation: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ In addition, you should know that to build our package we use Poetry, it's a Python package management tool that simplifies the process of building and publishing Python packages. It allows us to easily manage dependencies, virtual environments and package versions. Poetry also includes features such as dependency resolution, lock files and publishing to PyPI. Overall, Poetry streamlines the process of managing Python packages, making it easier for us to create and share our code with others. Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways: Report bugs at https://github.com/osl-incubator/envers/issues. If you are reporting a bug, please include: Look through the GitHub issues for bugs. Anything tagged with \u201cbug\u201d and \u201chelp wanted\u201d is open to whoever wants to implement it. Look through the GitHub issues for features. Anything tagged with \u201cenhancement\u201d and \u201chelp wanted\u201d is open to whoever wants to implement it. Envers could always use more documentation, whether as part of the official Envers docs, in docstrings, or even on the web in blog posts, articles, and such. The best way to send feedback is to file an issue at https://github.com/osl-incubator/envers/issues. If you are proposing a feature: Ready to contribute? Here\u2019s how to set up Fork the Clone your fork locally:: $ git clone git@github.com:your_name_here/envers.git Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: $ mkvirtualenv envers $ cd envers/ $ python setup.py develop Create a branch for local development:: $ git checkout -b name-of-your-bugfix-or-feature Now you can make your changes locally. When you\u2019re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: $ make lint $ make test To get flake8 and tox, just pip install them into your virtualenv. Commit your changes and push your branch to GitHub:: $ git add . $ git commit -m \u201cYour detailed description of your changes.\u201d $ git push origin name-of-your-bugfix-or-feature Submit a pull request through the GitHub website. Before you submit a pull request, check that it meets these guidelines: To run a subset of tests:: Release Notes
-0.3.0 (2023-12-22)
+0.4.0 (2023-12-23)
Features
+
+0.3.0 (2023-12-22)
+Features
+
0.2.0 (2023-12-15)
@@ -404,7 +410,7 @@ Bug Fixes
Features
+Features
diff --git a/search/search_index.json b/search/search_index.json
index 6af8919..62bf146 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#envers","title":"Envers","text":"
"},{"location":"#features","title":"Features","text":"
"},{"location":"#credits","title":"Credits","text":"
"},{"location":"changelog/#020-2023-12-15","title":"0.2.0 (2023-12-15)","text":""},{"location":"changelog/#bug-fixes","title":"Bug Fixes","text":"
"},{"location":"changelog/#features_1","title":"Features","text":"
"},{"location":"contributing/","title":"Contributing","text":"./src/envers
.
"},{"location":"contributing/#fix-bugs","title":"Fix Bugs","text":"
"},{"location":"contributing/#get-started","title":"Get Started!","text":"envers
for local development.
"},{"location":"contributing/#pull-request-guidelines","title":"Pull Request Guidelines","text":"envers
repo on GitHub.
"},{"location":"contributing/#tips","title":"Tips","text":"$ pytest tests.test_envers\n
This project uses semantic-release in order to cut a new release based on the commit-message.
"},{"location":"contributing/#commit-message-format","title":"Commit message format","text":"semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.
By default, semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset
or config
options_ of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.
Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.
The table below shows which commit message gets you which release type when semantic-release
runs (using the default configuration):
fix(pencil): stop graphite breaking when pressure is applied
Fix Release feat(pencil): add 'graphiteWidth' option
Feature Release perf(pencil): remove graphiteWidth option
Chore BREAKING CHANGE: The graphiteWidth option has been removed
Breaking Release source: https://github.com/semantic-release/semantic-release/blob/master/README.md#commit-message-format
As this project uses the squash and merge
strategy, ensure to apply the commit message format to the PR's title.
import envers\nimport envers In\u00a0[\u00a0]: Copied!
\n"},{"location":"example/#envers","title":"Envers\u00b6","text":"
Envers is Python library that aims to do ...
"},{"location":"example/#getting-started","title":"Getting Started\u00b6","text":"First, check our documentation about the installation.
Now, let's import our library:
"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#stable-release","title":"Stable release","text":"To install Envers, run this command in your terminal:
$ pip install envers\n
This is the preferred method to install Envers, as it will always install the most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
"},{"location":"installation/#from-sources","title":"From sources","text":"The sources for Envers can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone https://github.com/osl-incubator/envers\n
Or download the tarball:
$ curl -OJL https://github.com/osl-incubator/envers/tarball/main\n
Once you have a copy of the source, you can install it with:
$ poetry install\n
"},{"location":"api/references/","title":"Api references","text":""},{"location":"api/references/#envers","title":"envers
","text":"Envers.
"},{"location":"api/references/#envers-functions","title":"Functions","text":""},{"location":"api/references/#envers.get_version","title":"get_version()
","text":"Return the program version.
"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#envers","title":"Envers","text":"Envers is a tool for handling environment files (e.g. .env) for multiple kind of environments with versioning
The security of our code: Bandit is a powerful tool that we use in our Python project to ensure its security. This tool analyzes the code and detects potential vulnerabilities. Some of the key features of Bandit are its ease of use, its ability to integrate with other tools, and its support for multiple Python versions. If you want to know about bandit you can check its documentation.
Finds unused code: Vulture is useful for cleaning up and finding errors in large code bases in Python.
Complexity of functions and modules: We use McCabe to identify the complexity in our Python code that may be difficult to maintain or understand. By identifying complex code at the outset, we as developers can refactor it to make it easier to maintain and understand. In summary, McCabe helps us to improve the quality of our code and make it easier to maintain. If you would like to learn more about McCabe and code complexity, you can visit McCabe - Code Complexity Checker. This tool is included with Flake8.
TODO
This package was created with Cookieninja and the osl-incubator/scicookie project template.
"},{"location":"changelog/","title":"Release Notes","text":""},{"location":"changelog/#040-2023-12-23","title":"0.4.0 (2023-12-23)","text":""},{"location":"changelog/#features","title":"Features","text":"In order to be able to contribute, it is important that you understand the project layout. This project uses the src layout, which means that the package code is located at ./src/envers
.
For my information, check the official documentation: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/
In addition, you should know that to build our package we use Poetry, it's a Python package management tool that simplifies the process of building and publishing Python packages. It allows us to easily manage dependencies, virtual environments and package versions. Poetry also includes features such as dependency resolution, lock files and publishing to PyPI. Overall, Poetry streamlines the process of managing Python packages, making it easier for us to create and share our code with others.
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
"},{"location":"contributing/#types-of-contributions","title":"Types of Contributions","text":""},{"location":"contributing/#report-bugs","title":"Report Bugs","text":"Report bugs at https://github.com/osl-incubator/envers/issues.
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with \u201cbug\u201d and \u201chelp wanted\u201d is open to whoever wants to implement it.
"},{"location":"contributing/#implement-features","title":"Implement Features","text":"Look through the GitHub issues for features. Anything tagged with \u201cenhancement\u201d and \u201chelp wanted\u201d is open to whoever wants to implement it.
"},{"location":"contributing/#write-documentation","title":"Write Documentation","text":"Envers could always use more documentation, whether as part of the official Envers docs, in docstrings, or even on the web in blog posts, articles, and such.
"},{"location":"contributing/#submit-feedback","title":"Submit Feedback","text":"The best way to send feedback is to file an issue at https://github.com/osl-incubator/envers/issues.
If you are proposing a feature:
Ready to contribute? Here\u2019s how to set up envers
for local development.
Fork the envers
repo on GitHub.
Clone your fork locally::
$ git clone git@github.com:your_name_here/envers.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
$ mkvirtualenv envers $ cd envers/ $ python setup.py develop
Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you\u2019re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
$ make lint $ make test
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub::
$ git add . $ git commit -m \u201cYour detailed description of your changes.\u201d $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
To run a subset of tests::
$ pytest tests.test_envers\n
"},{"location":"contributing/#release","title":"Release","text":"This project uses semantic-release in order to cut a new release based on the commit-message.
"},{"location":"contributing/#commit-message-format","title":"Commit message format","text":"semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.
By default, semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset
or config
options_ of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.
Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.
The table below shows which commit message gets you which release type when semantic-release
runs (using the default configuration):
fix(pencil): stop graphite breaking when pressure is applied
Fix Release feat(pencil): add 'graphiteWidth' option
Feature Release perf(pencil): remove graphiteWidth option
Chore BREAKING CHANGE: The graphiteWidth option has been removed
Breaking Release source: https://github.com/semantic-release/semantic-release/blob/master/README.md#commit-message-format
As this project uses the squash and merge
strategy, ensure to apply the commit message format to the PR's title.
import envers\nimport envers In\u00a0[\u00a0]: Copied!
\n"},{"location":"example/#envers","title":"Envers\u00b6","text":"
Envers is Python library that aims to do ...
"},{"location":"example/#getting-started","title":"Getting Started\u00b6","text":"First, check our documentation about the installation.
Now, let's import our library:
"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#stable-release","title":"Stable release","text":"To install Envers, run this command in your terminal:
$ pip install envers\n
This is the preferred method to install Envers, as it will always install the most recent stable release.
If you don't have pip installed, this Python installation guide can guide you through the process.
"},{"location":"installation/#from-sources","title":"From sources","text":"The sources for Envers can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone https://github.com/osl-incubator/envers\n
Or download the tarball:
$ curl -OJL https://github.com/osl-incubator/envers/tarball/main\n
Once you have a copy of the source, you can install it with:
$ poetry install\n
"},{"location":"api/references/","title":"Api references","text":""},{"location":"api/references/#envers","title":"envers
","text":"Envers.
"},{"location":"api/references/#envers-functions","title":"Functions","text":""},{"location":"api/references/#envers.get_version","title":"get_version()
","text":"Return the program version.
"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 6180ab6..ba3e336 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,32 +2,32 @@