Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iwatakeshi/jmdict_ex
https://github.com/iwatakeshi/jmdict_ex
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/iwatakeshi/jmdict_ex
- Owner: iwatakeshi
- License: mit
- Created: 2024-06-29T23:55:33.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-30T00:26:08.000Z (6 months ago)
- Last Synced: 2024-06-30T09:22:50.007Z (6 months ago)
- Language: Elixir
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# JMDictEx
JMDictEx is an Elixir library for fetching, filtering, and downloading JMDict (Japanese-Multilingual Dictionary) and related dictionary files from the jmdict-simplified GitHub repository.
[](https://codecov.io/gh/iwatakeshi/jmdict_ex)
[](https://github.com/iwatakeshi/jmdict_ex/actions/workflows/elixir.yml)
## Features
- Fetch the latest dictionary assets from the jmdict-simplified GitHub repository
- Filter assets by source type, language, and archive type
- Download and extract selected assets to a specified destination
- Support for various dictionary types (JMDict, JMnedict, Kanjidic2, etc.) and multiple languages
## Installation
The package can be installed by adding `jmdict_ex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:jmdict_ex, git: "https://github.com/iwatakeshi/jmdict_ex.git", ref: "main" }
]
end
```
## Application Setup
JMDictEx is an OTP application that automatically starts necessary processes for Cachex. To ensure it starts properly:
1. Add `:jmdict_ex` to your list of applications in `mix.exs`:
```elixir
def application do
[
extra_applications: [:logger, :jmdict_ex]
]
end
2. If you're using releases, make sure to include :jmdict_ex in your release configuration.
3. Configure JMDictEx in your `config/config.exs` (or the appropriate config file for your environment):
```elixir
import Config
config :jmdict_ex, cache_ttl: 86400 # Cache Time-To-Live in seconds (24 hours is the default)
```
## Usage
Here are some basic usage examples:
```elixir
alias JMDictEx.Loaders.{JMDict, JMNEDict, Kanjidic2, Radkfile, Kradfile}
# Load and decode dictionary data
{:ok, jmdict} = JMDict.load(:all)
{:ok, jmnedict} = JMNEDict.load(:all)
{:ok, kanjidic2} = Kanjidic2.load(:all)
{:ok, radkfile} = Radkfile.load()
{:ok, kradfile} = Kradfile.load()
```
## Documentation
Detailed documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc). Once generated, the docs can be found in the `doc/` directory.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the [MIT License](LICENSE.md).
### JMdict
The origin of **JMdict** in the form of a JSON file is the repository [jmdict-simplified][jmdict-simplified].
In view of this, the said file is subject to the same license as its original source, namely **JMdict.xml**,
which is the intellectual property of the Electronic Dictionary Research and Development Group.
See [EDRDG License][EDRDG-license]All derived files are distributed under the same license, as the original license requires it.
### Kanjidic
The Kanjidic data used in this project is derived from the [jmdict-simplified][jmdict-simplified] project, which converts the original XML to JSON. The original kanjidic2.xml file is released under the [Creative Commons Attribution-ShareAlike License v4.0][CC-BY-SA-4]. See the Copyright and Permissions section on the Kanjidic wiki for details.
### RADKFILE/KRADFILE
The RADKFILE and KRADFILE files are copyright and available under the [EDRDG Licence][EDRDG-license].
The copyright of the RADKFILE2 and KRADFILE2 files is held by Jim Rose.
[jmdict-simplified]: https://github.com/scriptin/jmdict-simplified
[EDRDG-license]: http://www.edrdg.org/edrdg/licence.html
[Apache-2.0]: http://www.apache.org/licenses/LICENSE-2.0
[CC-BY-SA-4]: http://creativecommons.org/licenses/by-sa/4.0