Metadata-Version: 2.4
Name: lucyframework
Version: 0.1.0
Summary: Toy, personal framework built on Pygame
Author: Kadir Aksoy
Project-URL: homepage, https://github.com/kadir014/lucyframework
Project-URL: bugtracker, https://github.com/kadir014/lucyframework/issues
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: pygame
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygame-ce
Requires-Dist: miniprofiler>=0.0.2
Dynamic: license-file

# lucyframework
My personal, [pygbag](https://github.com/pygame-web/pygbag)-friendly, toy framework built for Pygame.



# Installation
Simply install from PyPI.
```shell
$ pip install lucyframework
```

Run the example.
```shell
$ lucyfw_example
```

Or initialize a template pygame project in your directory.
```shell
$ lucyfw_init
```

## Manual Installation
If you don't or can't download from PyPI.

Clone the repo and `cd` into it.
```shell
$ git clone https://github.com/kadir014/lucyframework.git
```

Build the framework, you can also use `uv`.
```shell
$ python -m pip install .
```

Then you can run the example app to test things out.
```shell
$ python -m lucyfw_example
```


# License
[MIT](LICENSE) © Kadir Aksoy
