https://github.com/narrativescience-old/python-package-template

Template repository for a publishable Python package
https://github.com/narrativescience-old/python-package-template

Last synced: 7 months ago
JSON representation

Template repository for a publishable Python package

• Host: GitHub
• URL: https://github.com/narrativescience-old/python-package-template
• Owner: NarrativeScience-old
• License: bsd-3-clause
• Created: 2020-01-07T22:57:59.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2021-07-26T19:49:38.000Z (almost 5 years ago)
• Last Synced: 2024-12-28T13:46:33.341Z (over 1 year ago)
• Language: Python
• Size: 13.7 KB
• Stars: 3
• Watchers: 15
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# mypackagename

[![](https://img.shields.io/pypi/v/mypackagename.svg)](https://pypi.org/pypi/mypackagename/) [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

Features:

- 

Table of Contents:

- [Installation](#installation)

- [Guide](#guide)

- [Development](#development)

## Installation

mypackagename requires Python 3.6 or above.

```bash

pip install mypackagename

```

## Guide

## Development

To develop mypackagename, install dependencies and enable the pre-commit hook:

```bash

pip install pre-commit poetry

poetry install

pre-commit install

```

To run tests:

```bash

poetry run pytest

```