Skip to content

Commit

Permalink
Setup new name
Browse files Browse the repository at this point in the history
  • Loading branch information
leynier committed Dec 5, 2020
1 parent bc8dd28 commit bd788b0
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 42 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Python Template
# Kickstarter

## Contributions are highly appreciated

### All contributors will be granted credit on the following list

* Leynier Gutiérrez González ([@leynier](https://github.com/leynier))
* Carlos Bermudez Porto ([@cbermudez97](https://github.com/cbermudez97))
* Tony Raúl Blanco Fernández ([@70nybl4nc0](https://github.com/70nybl4nc0))

You can help out by:

Expand All @@ -24,7 +26,7 @@ We're using the following branches to manage work:

## How to report bugs

We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/leynier/python-template/issues/new/choose); it's that easy!
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/codestrange/kickstarter/issues/new/choose); it's that easy!

### Write bug reports with detail, background, and sample code

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Leynier Gutiérrez González
Copyright (c) 2020 Leynier Gutiérrez González, Carlos Bermudez Porto y Tony Raúl Blanco Fernández

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
37 changes: 11 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,13 @@
# Python Template
# Kickstarter

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Test](https://github.com/leynier/python-template/workflows/CI/badge.svg)](https://github.com/leynier/python-template/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/leynier/python-template/branch/main/graph/badge.svg?token=Z1MEEL3EAB)](https://codecov.io/gh/leynier/python-template)
[![Version](https://img.shields.io/pypi/v/python-template?color=%2334D058&label=Version)](https://pypi.org/project/python-template)
[![Last commit](https://img.shields.io/github/last-commit/leynier/python-template.svg?style=flat)](https://github.com/leynier/python-template/commits)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/leynier/python-template)](https://github.com/leynier/python-template/commits)
[![Github Stars](https://img.shields.io/github/stars/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template/stargazers)
[![Github Forks](https://img.shields.io/github/forks/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template/network/members)
[![Github Watchers](https://img.shields.io/github/watchers/leynier/python-template?style=flat&logo=github)](https://github.com/leynier/python-template)
[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fleynier.github.io/python-template)](https://leynier.github.io/python-template)
[![GitHub contributors](https://img.shields.io/github/contributors/leynier/python-template)](https://github.com/leynier/python-template/graphs/contributors)

Python template with CI/CD ready for production

## Features

- Management of dependencies with [Poetry](https://python-poetry.org)
- Generation of documentation based on Markdown with [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material)
- Automatic check of the pythonic style with [flake8](https://flake8.pycqa.org), [black](https://black.readthedocs.io) and [isort](https://pycqa.github.io/isort)
- Automatic code checking with [pytest](https://pytest.org)
- Automatic code report with [codecov](https://codecov.io/)
- Automatic publish to [GitHub Releases](https://docs.github.com/es/free-pro-team@latest/github/administering-a-repository/releasing-projects-on-github)
- Automatic publish to [PyPI](https://pypi.org)
- Automatic dependency update check with [dependabot](https://github.com/dependabot)

> All of the above via [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com)
[![Test](https://github.com/codestrange/kickstarter/workflows/CI/badge.svg)](https://github.com/codestrange/kickstarter/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/codestrange/kickstarter/branch/main/graph/badge.svg?token=Z1MEEL3EAB)](https://codecov.io/gh/codestrange/kickstarter)
[![Version](https://img.shields.io/pypi/v/kickstarter?color=%2334D058&label=Version)](https://pypi.org/project/kickstarter)
[![Last commit](https://img.shields.io/github/last-commit/codestrange/kickstarter.svg?style=flat)](https://github.com/codestrange/kickstarter/commits)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/codestrange/kickstarter)](https://github.com/codestrange/kickstarter/commits)
[![Github Stars](https://img.shields.io/github/stars/codestrange/kickstarter?style=flat&logo=github)](https://github.com/codestrange/kickstarter/stargazers)
[![Github Forks](https://img.shields.io/github/forks/codestrange/kickstarter?style=flat&logo=github)](https://github.com/codestrange/kickstarter/network/members)
[![Github Watchers](https://img.shields.io/github/watchers/codestrange/kickstarter?style=flat&logo=github)](https://github.com/codestrange/kickstarter)
[![Website](https://img.shields.io/website?up_message=online&url=https%3A%2F%2Fcodestrange.github.io/kickstarter)](https://codestrange.github.io/kickstarter)
[![GitHub contributors](https://img.shields.io/github/contributors/codestrange/kickstarter)](https://github.com/codestrange/kickstarter/graphs/contributors)
File renamed without changes.
3 changes: 3 additions & 0 deletions kickstarter/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from .main import app

app(prog_name="kickstarter")
File renamed without changes.
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: Python Template
site_url: https://leynier.github.io/python-template
repo_url: https://github.com/leynier/python-template
site_name: Kickstarter
site_url: https://codestrange.github.io/kickstarter
repo_url: https://github.com/codestrange/kickstarter

theme:
name: material
Expand Down
14 changes: 7 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[tool.poetry]
name = "template"
version = "0.1.3"
description = "Python template with CI/CD ready for production"
name = "kickstarter"
version = "0.1.0"
description = ""
authors = ["leynier <[email protected]>"]
homepage = "https://github.com/leynier/python-template"
repository = "https://github.com/leynier/python-template"
documentation = "https://github.com/leynier/python-template"
homepage = "https://github.com/codestrange/kickstarter"
repository = "https://github.com/codestrange/kickstarter"
documentation = "https://github.com/codestrange/kickstarter"
readme = "README.md"
license = "MIT"

[tool.poetry.scripts]
template = "template.main:app"
kickstarter = "kickstarter.main:app"

[tool.poetry.dependencies]
python = "^3.8"
Expand Down
3 changes: 0 additions & 3 deletions template/__main__.py

This file was deleted.

0 comments on commit bd788b0

Please sign in to comment.