Contents

Overview

docs
tests
package

ignor is a Python CLI application that generates git ignore files for a specific language.

• Free software: GNU Lesser General Public License v3 (LGPLv3)

Installation

pip install ignor

You can also install the in-development version with:

pip install https://github.com/grafuls/python-ignor/archive/main.zip

Documentation

https://python-ignor.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Installation

At the command line:

git clone git@github.com:grafuls/python-ignor.git
cd python-ignor
pip install .

Usage

To use ignor from cli to get a list of supported languages:

ignor --list

To generate the .gitignore file for the specific language:

ignor nasaspecsintact

Reference

ignor

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

• Your operating system name and version.

• Any details about your local setup that might be helpful in troubleshooting.

• Detailed steps to reproduce the bug.

Documentation improvements

ignor could always use more documentation, whether as part of the official ignor docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/grafuls/python-ignor/issues.

If you are proposing a feature:

• Explain in detail how it would work.

• Keep the scope as narrow as possible, to make it easier to implement.

• Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up python-ignor for local development:

1. Fork python-ignor (look for the “Fork” button).

2. Clone your fork locally:

   git clone git@github.com:YOURGITHUBNAME/python-ignor.git
   

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

4. When you’re done making changes run all the checks and docs builder with one command:

   tox
   

5. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature
   

6. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

1. Include passing tests (run tox).

2. Update documentation when there’s new API, functionality etc.

3. Add a note to CHANGELOG.rst about the changes.

4. Add yourself to AUTHORS.rst.

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel:

tox -p auto

Authors

• Gonzalo Rafuls - https://quads.dev

Changelog

0.0.0 (2023-05-23)

• First release on PyPI.

Indices and tables

• Index

• Module Index

• Search Page