https://github.com/aitorres/lancini
Let's find all Spanish palindromes!
https://github.com/aitorres/lancini
Last synced: over 1 year ago
JSON representation
Let's find all Spanish palindromes!
- Host: GitHub
- URL: https://github.com/aitorres/lancini
- Owner: aitorres
- License: agpl-3.0
- Created: 2023-07-22T04:05:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T20:46:39.000Z (over 2 years ago)
- Last Synced: 2025-01-27T22:49:10.524Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 161 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lancini
Let's find all Spanish palindromes!
Lancini is a set of Python scripts to generate and store palindromes in the Spanish language, currently in development.
## Installation
Clone this repository with the recursive flag (to fetch submodules) and use [poetry](https://python-poetry.org/)[^1] to install the package:
```bash
git clone --recursive https://github.com/aitorres/lancini.git
cd lancini
poetry install
```
[^1]: You need __poetry__ to find palindromes, isn't it beautiful? By the way, this project is inspired by (and name after) Darío Lancini, a Venezuelan writer famous for his work exploring palindromes in fiction and poetry.
## Usage
You can use the `lancini` script as the entry point. `lancini` currently supports one command: `generate` to generate palindromes.
```bash
lancini generate
```
It's useful to note that:
- All data (output) will be stored to a `data` folder inside the project
- `lancini generate` can be interrupted and run again as it stores all found palindromes continuously (in batches), and will not store any duplicate palindromes on re-runs.
- Palindromes will be stored within a `csv` file with two columns: the generated "palindrome" (no space between words) and the corresponding phrase in Spanish as it was matched in the corpus.
- Note that it's plausible that a generated palindrome has more than one associated phrase, but the tool only generates the longest one. Try to break down palindrome phrases if you suspect it's possible ;-)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
This project is licensed under the [GNU Affero General Public License v3.0](https://github.com/aitorres/lancini/blob/main/LICENSE).