https://github.com/hombit/test-ppt

Repo to test LINCC Frameworks' python project template
https://github.com/hombit/test-ppt

Last synced: 7 days ago
JSON representation

Repo to test LINCC Frameworks' python project template

• Host: GitHub
• URL: https://github.com/hombit/test-ppt
• Owner: hombit
• License: mit
• Created: 2024-02-05T13:59:01.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-01T20:15:09.000Z (10 months ago)
• Last Synced: 2024-10-28T12:09:45.113Z (about 2 months ago)
• Language: Python
• Size: 62.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# example_project

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/example_project?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/example_project/)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/my-organization/example_project/smoke-test.yml)](https://github.com/my-organization/example_project/actions/workflows/smoke-test.yml)

[![codecov](https://codecov.io/gh/my-organization/example_project/branch/main/graph/badge.svg)](https://codecov.io/gh/my-organization/example_project)

[![Read the Docs](https://img.shields.io/readthedocs/example_project)](https://example_project.readthedocs.io/)

[![benchmarks](https://img.shields.io/github/actions/workflow/status/my-organization/example_project/asv-main.yml?label=benchmarks)](https://my-organization.github.io/example_project/)

This project was automatically generated using the LINCC-Frameworks 

[python-project-template](https://github.com/lincc-frameworks/python-project-template).

A repository badge was added to show that this project uses the python-project-template, however it's up to

you whether or not you'd like to display it!

For more information about the project template see the 

[documentation](https://lincc-ppt.readthedocs.io/en/latest/).

## Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a

virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual

environments. If you have conda installed locally, you can run the following to

create and activate a new environment.

```

>> conda create env -n  python=3.10

>> conda activate 

```

Once you have created a new environment, you can install this project for local

development using the following commands:

```

>> pip install -e .'[dev]'

>> pre-commit install

>> conda install pandoc

```

Notes:

1. The single quotes around `'[dev]'` may not be required for your operating system.

2. `pre-commit install` will initialize pre-commit for this local repository, so

   that a set of tests will be run prior to completing a local commit. For more

   information, see the Python Project Template documentation on 

   [pre-commit](https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html)

3. Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks

   into documentation for ReadTheDocs works as expected. For more information, see

   the Python Project Template documentation on

   [Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks)