An open API service indexing awesome lists of open source software.

https://github.com/areed1192/sigma-coding

This is a repository used for educational purposes to demonstrate how to upload a Python package to PyPi.
https://github.com/areed1192/sigma-coding

Last synced: 2 months ago
JSON representation

This is a repository used for educational purposes to demonstrate how to upload a Python package to PyPi.

Awesome Lists containing this project

README

        

# Sigma Coding Python Library

## Table of Contents

- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
- [Support These Projects](#support-these-projects)

## Overview

## Setup

Right now, the library is not hosted on **PyPi** so you will need to do a local
install on your system if you plan to use it in other scrips you use.

First, clone this repo to your local system. After you clone the repo, make sure
to run the `setup.py` file, so you can install any dependencies you may need. To
run the `setup.py` file, run the following command in your terminal.

```console
pip install -e .
```

This will install all the dependencies listed in the `setup.py` file. Once done
you can use the library wherever you want.

## Usage

Here is a simple example of using the `sigma` library to grab the index
files for specific quarter.

```python
```

## Support These Projects

**Patreon:**
Help support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding). I'm always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to pay monthly fees.

**YouTube:**
If you'd like to watch more of my content, feel free to visit my YouTube channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).