package-installer-cli 1.0.0

data/templates/flask/flask-cookiecutter-advance-template/{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/user/forms.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+"""User forms."""
+from flask_wtf import FlaskForm
+from wtforms import PasswordField, StringField
+from wtforms.validators import DataRequired, Email, EqualTo, Length
+
+from .models import User
+
+
+class RegisterForm(FlaskForm):
+    """Register form."""
+
+    username = StringField(
+        "Username", validators=[DataRequired(), Length(min=3, max=25)]
+    )
+    email = StringField(
+        "Email", validators=[DataRequired(), Email(), Length(min=6, max=40)]
+    )
+    password = PasswordField(
+        "Password", validators=[DataRequired(), Length(min=6, max=40)]
+    )
+    confirm = PasswordField(
+        "Verify password",
+        [DataRequired(), EqualTo("password", message="Passwords must match")],
+    )
+
+    def __init__(self, *args, **kwargs):
+        """Create instance."""
+        super(RegisterForm, self).__init__(*args, **kwargs)
+        self.user = None
+
+    def validate(self, **kwargs):
+        """Validate the form."""
+        initial_validation = super(RegisterForm, self).validate()
+        if not initial_validation:
+            return False
+        user = User.query.filter_by(username=self.username.data).first()
+        if user:
+            self.username.errors.append("Username already registered")
+            return False
+        user = User.query.filter_by(email=self.email.data).first()
+        if user:
+            self.email.errors.append("Email already registered")
+            return False
+        return True

data/templates/flask/flask-cookiecutter-advance-template/{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/user/models.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+"""User models."""
+import datetime as dt
+
+from flask_login import UserMixin
+from sqlalchemy.ext.hybrid import hybrid_property
+
+from {{cookiecutter.app_name}}.database import Column, PkModel, db, reference_col, relationship
+from {{cookiecutter.app_name}}.extensions import bcrypt
+
+
+class Role(PkModel):
+    """A role for a user."""
+
+    __tablename__ = "roles"
+    name = Column(db.String(80), unique=True, nullable=False)
+    user_id = reference_col("users", nullable=True)
+    user = relationship("User", backref="roles")
+
+    def __init__(self, name, **kwargs):
+        """Create instance."""
+        super().__init__(name=name, **kwargs)
+
+    def __repr__(self):
+        """Represent instance as a unique string."""
+        return f"<Role({self.name})>"
+
+
+class User(UserMixin, PkModel):
+    """A user of the app."""
+
+    __tablename__ = "users"
+    username = Column(db.String(80), unique=True, nullable=False)
+    email = Column(db.String(80), unique=True, nullable=False)
+    _password = Column("password", db.LargeBinary(128), nullable=True)
+    created_at = Column(
+        db.DateTime, nullable=False, default=dt.datetime.now(dt.timezone.utc)
+    )
+    first_name = Column(db.String(30), nullable=True)
+    last_name = Column(db.String(30), nullable=True)
+    active = Column(db.Boolean(), default=False)
+    is_admin = Column(db.Boolean(), default=False)
+
+    @hybrid_property
+    def password(self):
+        """Hashed password."""
+        return self._password
+
+    @password.setter
+    def password(self, value):
+        """Set password."""
+        self._password = bcrypt.generate_password_hash(value)
+
+    def check_password(self, value):
+        """Check password."""
+        return bcrypt.check_password_hash(self._password, value)
+
+    @property
+    def full_name(self):
+        """Full user name."""
+        return f"{self.first_name} {self.last_name}"
+
+    def __repr__(self):
+        """Represent instance as a unique string."""
+        return f"<User({self.username!r})>"

data/templates/flask/flask-cookiecutter-advance-template/{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/user/views.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+"""User views."""
+from flask import Blueprint, render_template
+from flask_login import login_required
+
+blueprint = Blueprint("user", __name__, url_prefix="/users", static_folder="../static")
+
+
+@blueprint.route("/")
+@login_required
+def members():
+    """List members."""
+    return render_template("users/members.html")

data/templates/flask/flask-cookiecutter-advance-template/{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/utils.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+"""Helper utilities and decorators."""
+from flask import flash
+
+
+def flash_errors(form, category="warning"):
+    """Flash all errors for a form."""
+    for field, errors in form.errors.items():
+        for error in errors:
+            flash(f"{getattr(form, field).label.text} - {error}", category)

data/templates/flask/flask-project-template/ABOUT_THIS_TEMPLATE.md

@@ -0,0 +1,198 @@
+# About this template
+
+Hi, I created this template to help you get started with a new project.
+
+I have created and maintained a number of python libraries, applications and 
+frameworks and during those years I have learned a lot about how to create a 
+project structure and how to structure a project to be as modular and simple 
+as possible.
+
+Some decisions I have made while creating this template are:
+
+ - Create a project structure that is as modular as possible.
+ - Keep it simple and easy to maintain.
+ - Allow for a lot of flexibility and customizability.
+ - Low dependency (this template doesn't add dependencies)
+
+## Structure
+
+Lets take a look at the structure of this template:
+
+```text
+├── Containerfile            # The file to build a container using buildah or docker
+├── CONTRIBUTING.md          # Onboarding instructions for new contributors
+├── docs                     # Documentation site (add more .md files here)
+│   └── index.md             # The index page for the docs site
+├── .github                  # Github metadata for repository
+│   ├── release_message.sh   # A script to generate a release message
+│   └── workflows            # The CI pipeline for Github Actions
+├── .gitignore               # A list of files to ignore when pushing to Github
+├── HISTORY.md               # Auto generated list of changes to the project
+├── LICENSE                  # The license for the project
+├── Makefile                 # A collection of utilities to manage the project
+├── MANIFEST.in              # A list of files to include in a package
+├── mkdocs.yml               # Configuration for documentation site
+├── project_name             # The main python package for the project
+│   ├── base.py              # The base module for the project
+│   ├── __init__.py          # This tells Python that this is a package
+│   ├── __main__.py          # The entry point for the project
+│   └── VERSION              # The version for the project is kept in a static file
+├── README.md                # The main readme for the project
+├── setup.py                 # The setup.py file for installing and packaging the project
+├── requirements.txt         # An empty file to hold the requirements for the project
+├── requirements-test.txt    # List of requirements for testing and devlopment
+├── setup.py                 # The setup.py file for installing and packaging the project
+└── tests                    # Unit tests for the project (add mote tests files here)
+    ├── conftest.py          # Configuration, hooks and fixtures for pytest
+    ├── __init__.py          # This tells Python that this is a test package
+    └── test_base.py         # The base test case for the project
+```
+
+## FAQ
+
+Frequent asked questions.
+
+### Why this template is not using [Poetry](https://python-poetry.org/) ?
+
+I really like Poetry and I think it is a great tool to manage your python projects,
+if you want to switch to poetry, you can run `make switch-to-poetry`.
+
+But for this template I wanted to keep it simple.
+
+Setuptools is the most simple and well supported way of packaging a Python project,
+it doesn't require extra dependencies and is the easiest way to install the project.
+
+Also, poetry doesn't have a good support for installing projects in development mode yet.
+
+### Why the `requirements.txt` is empty ?
+
+This template is a low dependency project, so it doesn't have any extra dependencies.
+You can add new dependencies as you will or you can use the `make init` command to
+generate a `requirements.txt` file based on the template you choose `flask, fastapi, click etc`.
+
+### Why there is a `requirements-test.txt` file ?
+
+This file lists all the requirements for testing and development,
+I think the development environment and testing environment should be as similar as possible.
+
+Except those tools that are up to the developer choice (like ipython, ipdb etc).
+
+### Why the template doesn't have a `pyproject.toml` file ?
+
+It is possible to run `pip install https://github.com/name/repo/tarball/main` and
+have pip to download the package direcly from Git repo.
+
+For that to work you need to have a `setup.py` file, and `pyproject.toml` is not
+supported for that kind of installation.
+
+I think it is easier for example you want to install specific branch or tag you can
+do `pip install https://github.com/name/repo/tarball/{TAG|REVISON|COMMIT}`
+
+People automating CI for your project will be grateful for having a setup.py file
+
+### Why isn't this template made as a cookiecutter template?
+
+I really like [cookiecutter](https://github.com/cookiecutter/cookiecutter) and it is a great way to create new projects,
+but for this template I wanted to use the Github `Use this template` button,
+to use this template doesn't require to install extra tooling such as cookiecutter.
+
+Just click on [Use this template](https://github.com/rochacbruno/python-project-template/generate) and you are good to go.
+
+The substituions are done using github actions and a simple sed script.
+
+### Why `VERSION` is kept in a static plain text file?
+
+I used to have my version inside my main module in a `__version__` variable, then
+I had to do some tricks to read that version variable inside the setuptools 
+`setup.py` file because that would be available only after the installation.
+
+I decided to keep the version in a static file because it is easier to read from
+wherever I want without the need to install the package.
+
+e.g: `cat project_name/VERSION` will get the project version without harming
+with module imports or anything else, it is useful for CI, logs and debugging.
+
+### Why to include `tests`, `history` and `Containerfile` as part of the release?
+
+The `MANIFEST.in` file is used to include the files in the release, once the 
+project is released to PyPI all the files listed on MANIFEST.in will be included
+even if the files are static or not related to Python.
+
+Some build systems such as RPM, DEB, AUR for some Linux distributions, and also
+internal repackaging systems tends to run the tests before the packaging is performed.
+
+The Containerfile can be useful to provide a safer execution environment for 
+the project when running on a testing environment.
+
+I added those files to make it easier for packaging in different formats.
+
+### Why conftest includes a go_to_tmpdir fixture?
+
+When your project deals with file system operations, it is a good idea to use
+a fixture to create a temporary directory and then remove it after the test.
+
+Before executing each test pytest will create a temporary directory and will
+change the working directory to that path and run the test.
+
+So the test can create temporary artifacts isolated from other tests.
+
+After the execution Pytest will remove the temporary directory.
+
+### Why this template is not using [pre-commit](https://pre-commit.com/) ?
+
+pre-commit is an excellent tool to automate checks and formatting on your code.
+
+However I figured out that pre-commit adds extra dependency and it an entry barrier
+for new contributors.
+
+Having the linting, checks and formatting as simple commands on the [Makefile](Makefile)
+makes it easier to undestand and change.
+
+Once the project is bigger and complex, having pre-commit as a dependency can be a good idea.
+
+### Why the CLI is not using click?
+
+I wanted to provide a simple template for a CLI application on the project main entry point
+click and typer are great alternatives but are external dependencies and this template
+doesn't add dependencies besides those used for development.
+
+### Why this doesn't provide a full example of application using Flask or Django?
+
+as I said before, I want it to be simple and multipurpose, so I decided to not include
+external dependencies and programming design decisions.
+
+It is up to you to decide if you want to use Flask or Django and to create your application
+the way you think is best.
+
+This template provides utilities in the Makefile to make it easier to you can run:
+
+```bash
+$ make init 
+Which template do you want to apply? [flask, fastapi, click, typer]? > flask
+Generating a new project with Flask ...
+```
+
+Then the above will download the Flask template and apply it to the project.
+
+## The Makefile
+
+All the utilities for the template and project are on the Makefile
+
+```bash
+❯ make
+Usage: make <target>
+
+Targets:
+help:             ## Show the help.
+install:          ## Install the project in dev mode.
+fmt:              ## Format code using black & isort.
+lint:             ## Run pep8, black, mypy linters.
+test: lint        ## Run tests and generate coverage report.
+watch:            ## Run tests on every change.
+clean:            ## Clean unused files.
+virtualenv:       ## Create a virtual environment.
+release:          ## Create a new tag for release.
+docs:             ## Build the documentation.
+switch-to-poetry: ## Switch to poetry package manager.
+init:             ## Initialize the project based on an application template.
+```

data/templates/flask/flask-project-template/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# How to develop on this project
+
+project_name welcomes contributions from the community.
+
+**You need PYTHON3!**
+
+This instructions are for linux base systems. (Linux, MacOS, BSD, etc.)
+## Setting up your own fork of this repo.
+
+- On github interface click on `Fork` button.
+- Clone your fork of this repo. `git clone git@github.com:YOUR_GIT_USERNAME/project_urlname.git`
+- Enter the directory `cd project_urlname`
+- Add upstream repo `git remote add upstream https://github.com/author_name/project_urlname`
+
+## Setting up your own virtual environment
+
+Run `make virtualenv` to create a virtual environment.
+then activate it with `source .venv/bin/activate`.
+
+## Install the project in develop mode
+
+Run `make install` to install the project in develop mode.
+
+## Run the tests to ensure everything is working
+
+Run `make test` to run the tests.
+
+## Create a new branch to work on your contribution
+
+Run `git checkout -b my_contribution`
+
+## Make your changes
+
+Edit the files using your preferred editor. (we recommend VIM or VSCode)
+
+## Format the code
+
+Run `make fmt` to format the code.
+
+## Run the linter
+
+Run `make lint` to run the linter.
+
+## Test your changes
+
+Run `make test` to run the tests.
+
+Ensure code coverage report shows `100%` coverage, add tests to your PR.
+
+## Build the docs locally
+
+Run `make docs` to build the docs.
+
+Ensure your new changes are documented.
+
+## Commit your changes
+
+This project uses [conventional git commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
+
+Example: `fix(package): update setup.py arguments 🎉` (emojis are fine too)
+
+## Push your changes to your fork
+
+Run `git push origin my_contribution`
+
+## Submit a pull request
+
+On github interface, click on `Pull Request` button.
+
+Wait CI to run and one of the developers will review your PR.
+## Makefile utilities
+
+This project comes with a `Makefile` that contains a number of useful utility.
+
+```bash 
+❯ make
+Usage: make <target>
+
+Targets:
+help:             ## Show the help.
+install:          ## Install the project in dev mode.
+fmt:              ## Format code using black & isort.
+lint:             ## Run pep8, black, mypy linters.
+test: lint        ## Run tests and generate coverage report.
+watch:            ## Run tests on every change.
+clean:            ## Clean unused files.
+virtualenv:       ## Create a virtual environment.
+release:          ## Create a new tag for release.
+docs:             ## Build the documentation.
+switch-to-poetry: ## Switch to poetry package manager.
+init:             ## Initialize the project based on an application template.
+```
+
+## Making a new release
+
+This project uses [semantic versioning](https://semver.org/) and tags releases with `X.Y.Z`
+Every time a new tag is created and pushed to the remote repo, github actions will
+automatically create a new release on github and trigger a release on PyPI.
+
+For this to work you need to setup a secret called `PIPY_API_TOKEN` on the project settings>secrets, 
+this token can be generated on [pypi.org](https://pypi.org/account/).
+
+To trigger a new release all you need to do is.
+
+1. If you have changes to add to the repo
+    * Make your changes following the steps described above.
+    * Commit your changes following the [conventional git commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
+2. Run the tests to ensure everything is working.
+4. Run `make release` to create a new tag and push it to the remote repo.
+
+the `make release` will ask you the version number to create the tag, ex: type `0.1.1` when you are asked.
+
+> **CAUTION**:  The make release will change local changelog files and commit all the unstaged changes you have.

data/templates/flask/flask-project-template/Containerfile

@@ -0,0 +1,9 @@
+FROM python:3.7-alpine
+COPY . /app
+WORKDIR /app
+RUN pip install .
+RUN project_name create-db
+RUN project_name populate-db
+RUN project_name add-user -u admin -p admin
+EXPOSE 5000
+CMD ["project_name", "run"]

data/templates/flask/flask-project-template/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

data/templates/flask/flask-project-template/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include HISTORY.md
+include Containerfile
+graft tests
+graft project_name

data/templates/flask/flask-project-template/Makefile

@@ -0,0 +1,119 @@
+.ONESHELL:
+ENV_PREFIX=$(shell python -c "if __import__('pathlib').Path('.venv/bin/pip').exists(): print('.venv/bin/')")
+USING_POETRY=$(shell grep "tool.poetry" pyproject.toml && echo "yes")
+
+.PHONY: help
+help:             ## Show the help.
+	@echo "Usage: make <target>"
+	@echo ""
+	@echo "Targets:"
+	@fgrep "##" Makefile | fgrep -v fgrep
+
+
+.PHONY: show
+show:             ## Show the current environment.
+	@echo "Current environment:"
+	@if [ "$(USING_POETRY)" ]; then poetry env info && exit; fi
+	@echo "Running using $(ENV_PREFIX)"
+	@$(ENV_PREFIX)python -V
+	@$(ENV_PREFIX)python -m site
+
+.PHONY: install
+install:          ## Install the project in dev mode.
+	@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
+	@echo "Don't forget to run 'make virtualenv' if you got errors."
+	$(ENV_PREFIX)pip install -e .[test]
+
+.PHONY: fmt
+fmt:              ## Format code using black & isort.
+	$(ENV_PREFIX)isort project_name/
+	$(ENV_PREFIX)black -l 79 project_name/
+	$(ENV_PREFIX)black -l 79 tests/
+
+.PHONY: lint
+lint:             ## Run pep8, black, mypy linters.
+	$(ENV_PREFIX)flake8 project_name/
+	$(ENV_PREFIX)black -l 79 --check project_name/
+	$(ENV_PREFIX)black -l 79 --check tests/
+	$(ENV_PREFIX)mypy --ignore-missing-imports project_name/
+
+.PHONY: test
+test: lint        ## Run tests and generate coverage report.
+	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=project_name -l --tb=short --maxfail=1 tests/
+	$(ENV_PREFIX)coverage xml
+	$(ENV_PREFIX)coverage html
+
+.PHONY: watch
+watch:            ## Run tests on every change.
+	ls **/**.py | entr $(ENV_PREFIX)pytest -s -vvv -l --tb=long --maxfail=1 tests/
+
+.PHONY: clean
+clean:            ## Clean unused files.
+	@find ./ -name '*.pyc' -exec rm -f {} \;
+	@find ./ -name '__pycache__' -exec rm -rf {} \;
+	@find ./ -name 'Thumbs.db' -exec rm -f {} \;
+	@find ./ -name '*~' -exec rm -f {} \;
+	@rm -rf .cache
+	@rm -rf .pytest_cache
+	@rm -rf .mypy_cache
+	@rm -rf build
+	@rm -rf dist
+	@rm -rf *.egg-info
+	@rm -rf htmlcov
+	@rm -rf .tox/
+	@rm -rf docs/_build
+
+.PHONY: virtualenv
+virtualenv:       ## Create a virtual environment.
+	@if [ "$(USING_POETRY)" ]; then poetry install && exit; fi
+	@echo "creating virtualenv ..."
+	@rm -rf .venv
+	@python3 -m venv .venv
+	@./.venv/bin/pip install -U pip
+	@./.venv/bin/pip install -e .[test]
+	@echo
+	@echo "!!! Please run 'source .venv/bin/activate' to enable the environment !!!"
+
+.PHONY: release
+release:          ## Create a new tag for release.
+	@echo "WARNING: This operation will create s version tag and push to github"
+	@read -p "Version? (provide the next x.y.z semver) : " TAG
+	@echo "creating git tag : $${TAG}"
+	@git tag $${TAG}
+	@echo "$${TAG}" > project_name/VERSION
+	@$(ENV_PREFIX)gitchangelog > HISTORY.md
+	@git add project_name/VERSION HISTORY.md
+	@git commit -m "release: version $${TAG} 🚀"
+	@git push -u origin HEAD --tags
+	@echo "Github Actions will detect the new tag and release the new version."
+
+.PHONY: docs
+docs:             ## Build the documentation.
+	@echo "building documentation ..."
+	@$(ENV_PREFIX)mkdocs build
+	URL="site/index.html"; xdg-open $$URL || sensible-browser $$URL || x-www-browser $$URL || gnome-open $$URL
+
+.PHONY: switch-to-poetry
+switch-to-poetry: ## Switch to poetry package manager.
+	@echo "Switching to poetry ..."
+	@if ! poetry --version > /dev/null; then echo 'poetry is required, install from https://python-poetry.org/'; exit 1; fi
+	@rm -rf .venv
+	@poetry init --no-interaction --name=a_flask_test --author=rochacbruno
+	@echo "" >> pyproject.toml
+	@echo "[tool.poetry.scripts]" >> pyproject.toml
+	@echo "project_name = 'project_name.__main__:main'" >> pyproject.toml 
+	@cat requirements.txt | while read in; do poetry add --no-interaction "$${in}"; done
+	@cat requirements-base.txt | while read in; do poetry add --no-interaction "$${in}" --dev; done
+	@cat requirements-test.txt | while read in; do poetry add --no-interaction "$${in}" --dev; done
+	@poetry install --no-interaction
+	@mkdir -p .github/backup
+	@mv requirements* .github/backup
+	@mv setup.py .github/backup
+	@echo "You have switched to https://python-poetry.org/ package manager."
+	@echo "Please run 'poetry shell' or 'poetry run project_name'"
+	
+	
+# This project has been generated from rochacbruno/flask-project-template
+# __author__ = 'rochacbruno'
+# __repo__ = https://github.com/rochacbruno/flask-project-template
+# __sponsor__ = https://github.com/sponsors/rochacbruno/