Skip to main content

A cool minesweeper

Project description

Mfranceschi Minesweeper

My_CI PyPI - Python Version PyPI license

(Far from) The best possible Minesweeper code!

Context

I am doing this side-project as a hobby. It is relatively easy to write a working minesweeper but it's harder to code nicely. My intention here is to write and enhance my code as I learn new coding guidelines. I am currently learning from the following sources:

  • book "Clean Code" by Robert C. Martin (2002)
  • book "The Pragmatic Programmer" by Andy Hunt and Dave Thomas (2019 Remaster)
  • YouTuber ArjanCodes

How to use

Requirements: Python >=3.7, Tkinter (for GUI code = for playing!).

Helper for Debian: sudo apt install -y python3.7 python3-tk.

Using PyPI

You can download and install the package from PyPI:

pip install mfranceschi-minesweeper
  • Play the game by running directly in your terminal mf-mines.
  • Use the code by importing the package mfranceschi_minesweeper (beware of the underscore '_').

Git clone

You can also clone this repo! Once it is done:

  • Install dependencies with pip install -r requirements.txt.
  • Other packages used during development (not required to interpret the files):
    • pylint (code linting)
    • mypy (type checking)
    • pytest (unit testing)
    • poetry (building and PyPI stuff)
  • Play the game by running from the repo's root python .
    • It will actually execute the file __main__.py.
  • Use the code at will! Recommended IDE is VS Code since I used it and added a .vscode/settings.json file in the repo.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mfranceschi-minesweeper-0.2.3.tar.gz (14.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page