Giter Club home page Giter Club logo

image-template's Introduction

Copier template MIT Software License latest version

Image Template

This template aims at making it easier to configure your projects that use Docker and Python (for example, for testing) to work with Github Actions and support a CI workflow.

It uses Copier to keep your projects updated with a unified GH Actions structure and configuration.

What this project adds and configures

  1. Docker automated builds with Github Actions
  2. Python project structure for Pytest with Poetry (optional)

1st usage

  1. Install Copier
  2. Enter your project folder: cd my-project
  3. Make it a git repo: git init
  4. Run copier copy https://github.com/Tecnativa/image-template.git .
  5. Answer questions
  6. Commit: git commit -am 'Apply image template' (repeat if some pre-commit configuration you have (e.g. https://github.com/copier-org/autopretty) reformats anything and makes the update fail)

Get updates

  1. Enter your project folder: cd my-project
  2. Update: copier -a .copier-answers.image-template.yml update
  3. Answer questions, if anything changed
  4. Commit: git commit -am 'Update image template' (repeat if pre-commit reformats anything and makes the update fail)

image-template's People

Contributors

joao-p-marques avatar yajo avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

yajo viknesh1211

image-template's Issues

Add basic CI

It is very important to have some basic CI here.

Some good starting points:

  • Test the template is produced OK with default input.
  • Test the github actions syntax.

Apply autopretty

We can't live without this anymore. ๐Ÿ˜‹

Apply it to the template itself. Templception!

Add CONTRIBUTING

It should contain instructions on how to develop locally and the pytest modifications important for local development.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.