digitalr00ts/fizzbuzzx

An unnecessarily over-engineered fizzbuzz solution

fizzbuzzx's Issues

Add Github Actions to run tests

Implementing Continuous Integration (CI) would catch such issues as seen in issue #2.

Docs:

• Introduction to GitHub Actions
• Running tests with tox

Add SCM versioning

https://github.com/pypa/setuptools_scm

Feature Request: RESTful API

Adding a REST API will enable us to curl for Fizzbuzz from a web endpoint. Once it can run as a service, we can hit from anywhere, i.e. SMS, chatbots, etc.

We should use OpenAPI as it is a common standard and comes with many features out of the box, including self-documenting. The Python library to help us with this should beFastAPI as it is high performance and will check our inputs. (validating user input, especially on the web, is a good way to prevent getting pwned).

Resources to get started:

• REST in a nutshell
  ☝️🧐 the "proper" definitions: https://restfulapi.net/
• A good overview of FastAPI w/ a small example: https://towardsdatascience.com/you-should-start-using-fastapi-now-7efb280fec02
• A slightly more complex usage of FastAPI: https://github.com/CMeza99/lcs

Add Stalebot

Dunno which one ATM:

• https://github.com/apps/stale
• https://github.com/apps/stalebot

Package and publish to the test PyPI

Lets publish to https://test.pypi.org/. See, PyPA's PyPUG: Using TestPyPI

Resources:

• What Are Python Wheels and Why Should You Care? Deepdive-ish. The parts about platform wheels, where compiling binary C/C++ extension is not relevant for this project at this time.
• PyPA's PyPUG: Packaging Your Project

PyPA = Python Packaging Authority
PyPUG = Python Packaging User Guide

Tests are failing

ERROR: lint: commands failed:

************* Module fizzbuzz
fizzbuzz.py:24:0: C0112: Empty class docstring (empty-docstring)
fizzbuzz.py:109:0: C0116: Missing function or method docstring (missing-function-docstring)
fizzbuzz.py:113:8: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)
fizzbuzz.py:141:8: R1722: Consider using sys.exit() (consider-using-sys-exit)

ERROR: style: commands failed:

1 file would be reformatted, 3 files would be left unchanged.

Add pre-commit hooks

https://pre-commit.com/

Add contributor guidelines

Question: Why is this repo tagged with cookiecutter-template?

I am guessing the cookiecutter-template tag on this project was a mistake. 😄

Fix failing tests

Pull request #46 introduced failing tests.

Add description

Add description to repo. Both in readme and "about" in Github.

RFC: Rename project to FizzBuzzX

I am proposing this project be renamed to FizzBuzzX.
My reasons include:

1. Internally we already refer to this project as Fizz Buzz extreme.
2. It will help with discovery and SEO.
3. fizzbuzzx is available at PyPI
4. fizzbuzzx.com is available (though I am not opposed to other TLDs)
5. The name of the repo and the name of the package in setup.cfg do not match right now anyways.

@pelmini what are your thoughts?

RFC = Request For Comments

Add Hacktoberfest tag

Git actions are failing for python 3.10

Increase code coverage

Can we get 100% coverage?

Feeling extra froggy? Lets try property based testing with Hypothesis. (maybe this should be a separate ticket)

Publish docs to Github Pages

Add Codecov integration

Now that we have code coverage, we should integrate w/ Codecov.

Register domain for project

We need to decide what TLD we are going to use.

• fizzbuzzx.com
• fizzbuzzx.io
• etc

I do suggest Namecheap as our registrar as, I know what features they have, they are not evil, they support DNSSEC, and we can share admin of domains.

I am assigning the ticket to @pelmini to gain experience operating a website and DNS.

Tests Still failing 😞

Still failing tests 😞

style run-test: commands[0] | black --check .
would reformat /home/digitalr00ts/Documents/git/fizzbuzz/fizzbuzz.py
Oh no! 💥 💔 💥
1 file would be reformatted, 3 files would be left unchanged.

I think this highlights the need to prioritize getting CI setup soon, so I opened issue #7 😄 .

Originally posted by @CMeza99 in #2 (comment)