Giter VIP home page Giter VIP logo

pythonprojecttemplate's Introduction

FastVector

Python License Build codecov Documentation

Template For Python Projects

This is a template for Python projects. What you get:

  • Source code and test code is seperated in different directories.
  • External libraries installed and managed by Pip and setuptools in a pyproject.toml.
  • Setup for tests using Pytest and coverage with Pytest-Cov.
  • Continuous testing with Github-Actions including pre-commit.
  • Code coverage reports, including automatic upload to Codecov.
  • Code documentation with Mkdocs.

Structure

├── pyproject.toml
├── ... other config files ...
├── docs
│   ├── api.md
│   └── index.md
├── examples
│   └── ...
├── fastvector
│   ├── __init__.py
│   ├── vector.py
│   └── version.py
└── tests
    ├── __init__.py
    └── test_vector.py

Commands

# Build and Install (local)
pip install -e .  # OR
pip install -e ../Python-Project-Template  # OR
pip install -e ../Python-Project-Template[all]
# Test
pytest tests  # OR
pytest .  # OR
pytest
# Code Coverage
pytest --cov=fastvector tests --cov-report=html

pythonprojecttemplate's People

Contributors

franneck94 avatar mariosk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

pythonprojecttemplate's Issues

Packaging wont work if you add any other package dependency in your package

How to reproduce:

  1. Add import numpy as np into your vector.py file and for example this dummy method into Vector2D class
    #vector.py
    import numpy as np
    ...    

    class Vector2D:
    ...
        def get_numpy_version(self):
            return np.__version__
    ...
  1. run pip install -e .

you will get

# terminal output
(.venv) ...>pip install -e .
Obtaining .../VSCode/PythonProjectTemplate
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... error
  ,,,
  ModuleNotFoundError: No module named 'numpy'

you can fix this by making the following change int the pyproject.toml file, changing this

[tool.setuptools.dynamic]
version = {attr = "fastvector.__version__"}

to this

[tool.setuptools.dynamic]
version = {attr = "fastvector.version.__version__"}

OR

by adding Numpy to the build system dependencies

[build-system]
requires = [
    "setuptools",
    "setuptools-scm",
    "numpy",
]

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.