Skip to content

Commit

Permalink
Switch to pyproject.toml; bump version to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
will2dye4 committed Sep 15, 2023
1 parent ebae6ed commit 2ecb138
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 40 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
**/__pycache__/
.ipynb_checkpoints/
build/
dist/
labyrinth.egg-info/
media/

*.egg-info/

**/*.pyc
**/.DS_Store
*.ipynb
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright 2023 William Dye

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
5 changes: 0 additions & 5 deletions Makefile

This file was deleted.

19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,14 @@ in this package.

## Installation

The package is not currently available on PyPI or any other Python package repository. The easiest
way to install it is to clone the GitHub repository and install it from source.
The easiest way to install the package is to download it from [PyPI](https://pypi.org) using `pip`.
Note that `labyrinth` depends on [Python](https://www.python.org/downloads/) 3.7 or newer; please
ensure that you have a semi-recent version of Python installed before proceeding.

### Prerequisites

* [Python](https://www.python.org/downloads/) 3.7 or newer
* [Git](https://git-scm.com)
* [Make](https://www.gnu.org/software/make/)

### Installation Instructions

Run the following commands in a shell (a UNIX-like environment is assumed):
Run the following command in a shell (a UNIX-like environment is assumed):

```
$ git clone [email protected]:will2dye4/labyrinth.git
$ cd labyrinth
$ make install
$ pip install labyrinth-py
```

The package does not have any dependencies besides Python itself. If you wish to
Expand Down
32 changes: 32 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[build-system]
requires = ['setuptools']
build-backend = 'setuptools.build_meta'

[project]
name = 'labyrinth-py'
version = '1.0.0'
description = 'Generate and solve mazes using various algorithms'
license = {file = 'LICENSE'}
readme = 'README.md'
authors = [
{name = 'William Dye'},
]
keywords = [
"dfs", "depth first search", "kruskal's algorithm", "labyrinth", "labyrinth generator", "labyrinth gui",
"labyrinth solver", "labyrinth ui", "maze", "maze generator", "maze gui", "maze solver", "maze ui",
"prim's algorithm", "wilson's algorithm",
]
requires-python = '>=3.7'

[project.scripts]
labyrinth = 'labyrinth.__main__:main'
labyrinth-ui = 'labyrinth.__main__:gui'
maze = 'labyrinth.__main__:main'
maze-ui = 'labyrinth.__main__:gui'

[project.urls]
Repository = 'https://github.com/will2dye4/labyrinth.git'

[tool.setuptools.packages.find]
include = ['labyrinth*']
namespaces = false
17 changes: 0 additions & 17 deletions setup.py

This file was deleted.

0 comments on commit 2ecb138

Please sign in to comment.