Metadata-Version: 2.1
Name: fakeproj-nightly
Version: 20210308
Summary: Mostly useless code to demonstrate Python DevOps tools
Home-page: https://github.com/lazyoracle/fakeproj
Author: Anurag Saha Roy
Author-email: anurag.roni@gmail.com
License: UNKNOWN
Description: # fakeproj: DevOps for Dummies
        
        ![unit test](https://github.com/lazyoracle/fakeproj/workflows/Unit%20Testing/badge.svg)
        ![integration test](https://github.com/lazyoracle/fakeproj/workflows/Integration%20Testing/badge.svg)
        ![coverage](https://github.com/lazyoracle/fakeproj/workflows/Code%20Coverage/badge.svg)
        [![codecov](https://codecov.io/gh/lazyoracle/fakeproj/branch/master/graph/badge.svg)](https://codecov.io/gh/lazyoracle/fakeproj)
        ![complexity test](https://github.com/lazyoracle/fakeproj/workflows/Code%20Complexity/badge.svg)
        ![build test](https://github.com/lazyoracle/fakeproj/workflows/Python%20package%20Build/badge.svg)
        
        <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
        [![Documentation Status](https://readthedocs.org/projects/fakeproj/badge/?version=latest)](https://fakeproj.readthedocs.io/en/latest/?badge=latest)
        [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/lazyoracle/fakeproj/graphs/commit-activity)
        [![GitHub issues](https://img.shields.io/github/issues/lazyoracle/fakeproj.svg)](https://GitHub.com/lazyoracle/fakeproj/issues/)
        [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
        
        [![PyPI version fury.io](https://badge.fury.io/py/fakeproj.svg)](https://pypi.python.org/pypi/fakeproj/)
        [![PyPI license](https://img.shields.io/pypi/l/fakeproj.svg)](https://pypi.python.org/pypi/fakeproj/)
        [![PyPI pyversions](https://img.shields.io/pypi/pyversions/fakeproj.svg)](https://pypi.python.org/pypi/fakeproj/)
        [![GitHub release](https://img.shields.io/github/release/lazyoracle/fakeproj.svg)](https://GitHub.com/lazyoracle/fakeproj/releases/)
        
        A dummy project to introduce various DevOps tools and Best Practices to Python developers. Follow along with the tutorial on [fakeproj.readthedocs.io](https://fakeproj.readthedocs.io)
        
        ## Installation
        
        ```bash
        pip install .
        ```
        
        ### Developer Setup
        
        ```bash
        pip install -r requirements.txt
        ```
        
        ### Testing
        
        ```bash
        pytest -s -v --cov=fakeproj test/
        ```
        
        There are markers for individual modules from the library, eg, 
        
        ```bash
        pytest -v -m "goodmodule" --cov=fakeproj test/
        ```
        
        ### Benchmarks
        
        Benchmarks can be run locally using `asv run`, followed by `asv publish` and `asv preview`.
        
        The benchmarks are also available to view online at [here](https://lazyoracle.github.io/fakeproj/).
        
        To update the online dashboard by pushing the latest benchmarks, use `asv gh-pages`
        
        ### Complexity
        
        ```bash
        radon cc -a .
        xenon --max-absolute B --max-modules B --max-average A .
        ```
        
        ### Docstrings
        
        ```bash
        docstr-coverage .
        ```
        
        ### GitHub Actions
        
        * Unit Testing (Python 3.6, 3.7, 3.8 on ubuntu:latest)
        * Code Coverage
        * Code Complexity (Maximum CC of B/B/A)
        * Build Testing (Python 3.6, 3.7, 3.8 on {ubuntu, macos, windows}:latest)
        
        ### Code Formatting
        
        This project uses [Black](https://black.readthedocs.io/en/stable/) for Code Formatting
        
        ## To-Do
        
        - [ ] Populate Docs
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.6
Description-Content-Type: text/markdown
