Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luismayta/cookiecutter-base


https://github.com/luismayta/cookiecutter-base

cookiecutter generator peru python template

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

[![Latest Release](https://img.shields.io/github/release/luismayta/cookiecutter-base)](https://github.com/luismayta/cookiecutter-base/releases) [![Lint](https://img.shields.io/github/workflow/status/luismayta/cookiecutter-base/lint-code)](https://github.com/luismayta/cookiecutter-base/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/luismayta/cookiecutter-base/ci)](https://github.com/luismayta/cookiecutter-base/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/luismayta/cookiecutter-base/test)](https://github.com/luismayta/cookiecutter-base/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)

# cookiecutter-base

cookiecutter-base for project

### Replace name project to New Project

```bash
agr 'cookiecutter-base' 'new-project'
agr 'CookiecutterBase' 'NewProject'
```

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [gomplate](https://github.com/hairyhenderson/gomplate)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Installation

### Dependencies

Install `cookiecutter` command line:

#### Pip users

```bash
pip install cookiecutter
```

#### Homebrew users

```bash
brew install cookiecutter
```

#### Windows or Pipenv users

```bash
pipenv install cookiecutter
```

## Usage

# How to use this project

```bash
cookiecutter gh:luismayta/cookiecutter-base
```

## Examples

### common

## Help

**Got a question?**

File a GitHub [issue](https://github.com/luismayta/cookiecutter-base/issues).

## Contributing

See [Contributing](./docs/contributing.md).

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2022 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like cookiecutter-base

[Your feedback is appreciated](https://github.com/luismayta/cookiecutter-base/issues)