semvec/pypi-packages huggingface dataset:
logoizer 0.2.0.post1
Make CSDMS text logos
License: MIT
Requires Python: >=3.11
Keywords: csdms, logo

![Logoizer][logoizer-logo]

[logoizer-logo]: https://raw.githubusercontent.com/mcflugen/logoizer/main/docs/_static/logoizer-logo-light.svg

# Make CSDMS text logos

## Installation

*logoizer* can be installed from source in the usual way or directly from GitHub,

```bash
pip install git+https://github.com/mcflugen/logoizer
```

## Usage

The main way to use *logoizer* is through the *logoize* command line program.
Use `logoize --help` to get a brief help message that contains all of the
available options. The following examples, however, will cover most use cases.

Turn the word "logoizer" into an official CSDMS logo,

```bash
logoize "logoizer" -o logoizer-logo.svg
```

The default is to create a logo for use with a light theme (i.e. the logo
will contain black text on a transparent background). To create a logo for
use with a dark theme,

```bash
logoize "logoizer" -o logoizer-logo-dark.svg --theme=dark
```

The output image format will be chosen based on the output file extension. If,
however, you would like to override that behavior you can use the `--format`
option.

# Release Notes

<!-- towncrier-draft-entries:: Not yet released -->

<!-- towncrier release notes start -->

## 0.2.0 (2024-10-15)


### 📖 Documentation Enhancements

- Converted the docs from ReStructuredText to markdown. [#6](https://github.com/mcflugen/logoizer/issues/6)
- Modified towncrier to work with markdown rather than ReStructuredTxt. [#7](https://github.com/mcflugen/logoizer/issues/7)


### 🔩 Other Changes and Additions

- Updated the linters and added several new ones. [#4](https://github.com/mcflugen/logoizer/issues/4)
- Removed dependency on *click* (and *rich_click*) by moving to *argparse*. [#5](https://github.com/mcflugen/logoizer/issues/5)
- Added a GitHub Actions *test* workflow. [#8](https://github.com/mcflugen/logoizer/issues/8)

## 0.1.0 (2022-07-03)

### 🍰 New Features

- Added the logize package for creating official CSDMS text-based logos. ([#1](https://github.com/mcflugen/logoizer/issues/1))

### 🔩 Other Changes and Additions

- Changed the name of the project from *logoize* to *logoizer*. ([#2](https://github.com/mcflugen/logoizer/issues/2))