Skip to main content

Build the contents of a single .gitignore from several sources.

Project description

gitignore-builder

PyPI - Python Version PyPI - Version Hatch project


Table of Contents


Usage

CLI command's 'help' output:

Usage: gitignore-builder [OPTIONS] {android|java|python} [OUTPUT]

  Generate .gitignore contents from recipe and write them to the output.

Options:
  -c, --config  Print the location of app config files.
  -h, --help    Show this message and exit.

Sample CLI command invocations

# print the command help description
gitignore-builder --help

# print absolute paths to the app config files
gitignore-builder --config

# generate and print .gitignore file contents
gitignore-builder java

# generate and write the contents to '.gitignore' file in current dir
gitignore-builder python .gitignore

Installation

Installing with Pip

# from PyPI 
pip install gitignore-builder

# from source
git clone git@github.com:Hrissimir/gitignore-builder.git
cd gitignore-builder
pip install .

Changelog

Version 1.0.1

  • Minor bugfix

Version 1.0.0

  • Introduced the concepts of 'recipes' and 'templates'
  • Implemented usage of recipes.yaml and templates.yaml
    • Created in per-user app-config dir upon first usage
    • Editable by the user to provide extra/custom values
  • Implemented support for printing paths to the app data-files
  • Improved of the bundled lists of templates and recipes
  • Improved CLI command help-description.
  • Better unit-tests coverage

Version 0.1.0

  • Added basic implementation of the CLI command.
  • Initial PyPI publication.

Version 0.0.1

  • Generated project skeleton
  • Added README.md
  • Added CONTRIBUTING.md
  • Configured the GitHub CI/CD pipeline.

License

gitignore-builder is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitignore_builder-1.0.1.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitignore_builder-1.0.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file gitignore_builder-1.0.1.tar.gz.

File metadata

  • Download URL: gitignore_builder-1.0.1.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.9

File hashes

Hashes for gitignore_builder-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4b68fca47a4e68f9cdd1c016413a7f4b501324b3d40fa9095037304d3c437f7d
MD5 a3e851e8b30bfc3383217f8d96d50562
BLAKE2b-256 fc4496d14eadec0d10a643d599d22510c8db81f5ebac2140c49c81a46c39dc44

See more details on using hashes here.

File details

Details for the file gitignore_builder-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gitignore_builder-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 204e880191667f30a4297128584d5f2c1492b79592522806cea0a91e4f101c7b
MD5 5d95a4d977fe2fdf64121a0c9b649c48
BLAKE2b-256 3ba1e2b64eb3fba1977ce9f12bdc4e29fe00a6cbee35a7486cfbb5c45b19ea25

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page