cadmium v0.3.0

Cadmium is a Natural Language Processing (NLP) library for Crystal.

For full API documentation check out the docs.

For more complete and up to date information about specific parts of Cadmium, check out each relevant shard repository.

Installation

Your project should only include the Cadmium shard(s) you need.

However, in case you want to test out all of Cadmium in a simple way, you can install all modules of the project in a few lines.

Add this to your application's shard.yml:

dependencies:
  cadmium:
    github: cadmiumcr/cadmium
    branch: master

Development

This repository uses git submodules to include all Cadmium modules in a monorepo structure.

Setting Up Development Environment

Clone with submodules:

git clone --recursive git@github.com:cadmiumcr/cadmium.git
cd cadmium

If you already cloned without submodules:

git submodule update --init --recursive

Install dependencies:

SHARDS_OVERRIDE=shard.dev.yml shards install

Working with Submodules

Making Changes to a Module

Each module is a separate git repository. To make changes:

1. Navigate to the module directory:

   cd shards/cadmium_language_detector
   

2. Create a branch for your changes (recommended):

   git checkout -b feature/my-changes
   

3. Make your changes, commit, and push to the module's repository:

   git add .
   git commit -m "Describe your changes"
   git push origin feature/my-changes
   

4. Update the parent repository to reference the new submodule commit:

   cd ../..
   git add shards/cadmium_language_detector
   git commit -m "Update cadmium_language_detector submodule"
   

Updating All Submodules

To update all submodules to their latest versions:

git submodule update --remote --merge
git add shards/
git commit -m "Update all submodules"

Updating a Single Submodule

cd shards/cadmium_language_detector
git pull origin master  # or main
cd ../..
git add shards/cadmium_language_detector
git commit -m "Update cadmium_language_detector"

Checking Submodule Status

# See status of all submodules
git submodule status

# See which submodules have changes
git submodule summary

Troubleshooting

Detached HEAD in Submodule: If you're in a detached HEAD state inside a submodule, create a branch:

cd shards/cadmium_language_detector
git checkout -b my-feature-branch

Submodule Not Initialized:

git submodule init
git submodule update

Submodule Out of Date:

git submodule update --remote

Using Justfile

This repository includes a justfile with convenient commands for managing the monorepo. Install just and run just to see all available commands.

Common commands:

# Install dependencies
just install

# Update all submodules
just update-submodules

# Run tests for a specific shard
just test cadmium_language_detector

# Format all shards
just format-all

# Release a new version of a shard
just release cadmium_language_detector 1.2.3 "Bump version to 1.2.3"

Contributing

1. Fork it ( https://github.com/cadmiumcr/cadmium/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

This project exists thanks to all the people who contribute.