README.md
# dobble
[](https://www.python.org)
[](https://www.gnu.org/licenses/gpl-3.0.html.en)
[](https://python-poetry.org/)
[](https://github.com/mrvnthss/dobble/actions/workflows/python-package.yml)
[](https://codecov.io/gh/mrvnthss/dobble)
[](https://app.codacy.com/gh/mrvnthss/dobble/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://codeclimate.com/github/mrvnthss/dobble/maintainability)
<br>
<div align="center">
<img src="imgs/cards/card_examples.gif" alt="playing-cards" width="500">
</div>
## Table of Contents
- [References](#references)
- [Acknowledgments](#acknowledgments)
- [License](#license)
- [Coding Style](#coding-style)
## References
- Bruck, R. H., & Ryser, H. J. (1949). The nonexistence of certain finite projective planes. *Canadian Journal of Mathematics, 1*(1), 88–93. [https://doi.org/10.4153/CJM-1949-009-2](https://doi.org/10.4153/CJM-1949-009-2)
- Montaron, B. (1985). On incidence matrices of finite projective planes. *Discrete Mathematics, 56*(2-3), 227-237. [https://doi.org/10.1016/0012-365X(85)90029-9](https://doi.org/10.1016/0012-365X(85)90029-9)
- Paige, L. J., & Wexler, C. (1953). A canonical form for incidence matrices of finite projective planes and their associated latin squares. *Portugaliae Mathematica, 12*, 105-112.
## Acknowledgments
All emojis designed by [**OpenMoji**](https://openmoji.org/) - the open-source emoji and icon project. License: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0)
All data on circle packings are taken from [**packomania.com**](http://www.packomania.com).
## License
This project is open source and available under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) (GPLv3). The GPLv3 is a copyleft license that allows for the free distribution, modification, and use of this software, ensuring that all derivatives of this work are also available under the same license. Here’s a summary of the license’s main points:
- **Freedom to Use**: You are free to use this software for any purpose, including commercial applications, in accordance with the license terms.
- **Freedom to Modify**: You can modify the source code of this software, allowing you to tailor it to your needs or improve upon it. Your modifications must also be licensed under GPLv3.
- **Freedom to Share**: You can distribute this software freely, whether in its original form or with your modifications, as long as you also make the source code available under the same license terms.
- **Share Alike**: If you distribute modified versions of this software, you must also do so under the GPLv3, ensuring that all derivatives remain free and open source under the same terms.
- **Attribution and Notices**: When distributing or modifying the project's software, you must retain all copyright notices and author attributions found in the original work, as well as provide notices that you have modified the work. This ensures transparency and respects the original creators' contributions.
- **No Additional Restrictions**: You may not impose any further restrictions on the recipients' exercise of the rights granted under the license. This includes not using legal terms or technological measures that legally restrict others from doing anything the license permits.
For more detailed information, please review the full [LICENSE](LICENSE) text. By using, distributing, or contributing to this project, you agree to abide by the terms of the GNU GPLv3.
## Coding Style
- [PEP8](https://peps.python.org/pep-0008/) formatting
- Maximum line length of 99 characters (72 characters for docstrings)
- Consistent use of double-quoted strings