https://github.com/pjiwm/vocabulizer-dictionary-cli
vocabulizer: CLI tool for generating and maintaining dictionaries in sqlite format.
https://github.com/pjiwm/vocabulizer-dictionary-cli
cli dictionaries foreign-language language language-tool python sqlite3
Last synced: over 1 year ago
JSON representation
vocabulizer: CLI tool for generating and maintaining dictionaries in sqlite format.
- Host: GitHub
- URL: https://github.com/pjiwm/vocabulizer-dictionary-cli
- Owner: Pjiwm
- License: mit
- Created: 2024-09-07T14:46:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T17:55:33.000Z (over 1 year ago)
- Last Synced: 2025-01-13T07:27:55.502Z (over 1 year ago)
- Topics: cli, dictionaries, foreign-language, language, language-tool, python, sqlite3
- Language: Python
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Vocabulizer Dictionary CLI
**Vocabulizer Dictionary CLI** is a tool for creating and managing dictionary databases with a generic schema. This CLI tool is designed to handle various dictionary formats and is ideal for building custom dictionary databases.
## Features
- **Generic DB Schema:** Provides a consistent schema for different dictionaries.
- **Support for Multiple Dictionary Formats:** Allow custom implementations to parse different file types.
- **Extensible:** Easy to add support for new dictionary formats and languages.
## Requirements
- Python 3.7 or later
- A virtual environment (venv)
## Installation
1. **Clone the Repository:**
```bash
git clone https://github.com/yourusername/vocabulizer-dictionary-cli.git
cd vocabulizer-dictionary-cli
```
2. **Create and Activate a Virtual Environment:**
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. **Install Required Packages:**
```bash
pip install -r requirements.txt
```
4. **Run the CLI Tool:**
```bash
python src/main.py
```
## Usage
The CLI tool is used to create and manage dictionary databases. You can customize it by adding new dictionary formats or languages. For more details on usage, refer to the documentation within the `src` directory.
## Contribution
contributions to **Vocabulizer Dictionary CLI** are welcome. If you’d like to help, here are a few ways you can contribute:
- **Add Support for More Languages:** Extend the tool to handle dictionaries in additional languages.
- **Submit Bug Reports and Feature Requests:** Report any bugs or suggest new features.
To contribute, please fork the repository, make your changes, and submit a pull request.
[Contributing guide](CONTRIBUTING.md).
## License
This project is licensed under the [MIT License](LICENSE).