| Name | logoizer JSON |
| Version |
0.2.0.post1
JSON |
| download |
| home_page | None |
| Summary | Make CSDMS text logos |
| upload_time | 2024-10-16 05:36:51 |
| maintainer | Eric Hutton |
| docs_url | None |
| author | Eric Hutton |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
csdms
logo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
![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))
Raw data
{
"_id": null,
"home_page": null,
"name": "logoizer",
"maintainer": "Eric Hutton",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "mcflugen@gmail.com",
"keywords": "csdms, logo",
"author": "Eric Hutton",
"author_email": "mcflugen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/fd/22e019f72cc86c6a79a77c9efab6ae63a86c2a7ae52c9ab6ca07aaa29436/logoizer-0.2.0.post1.tar.gz",
"platform": null,
"description": "![Logoizer][logoizer-logo]\n\n[logoizer-logo]: https://raw.githubusercontent.com/mcflugen/logoizer/main/docs/_static/logoizer-logo-light.svg\n\n# Make CSDMS text logos\n\n## Installation\n\n*logoizer* can be installed from source in the usual way or directly from GitHub,\n\n```bash\npip install git+https://github.com/mcflugen/logoizer\n```\n\n## Usage\n\nThe main way to use *logoizer* is through the *logoize* command line program.\nUse `logoize --help` to get a brief help message that contains all of the\navailable options. The following examples, however, will cover most use cases.\n\nTurn the word \"logoizer\" into an official CSDMS logo,\n\n```bash\nlogoize \"logoizer\" -o logoizer-logo.svg\n```\n\nThe default is to create a logo for use with a light theme (i.e. the logo\nwill contain black text on a transparent background). To create a logo for\nuse with a dark theme,\n\n```bash\nlogoize \"logoizer\" -o logoizer-logo-dark.svg --theme=dark\n```\n\nThe output image format will be chosen based on the output file extension. If,\nhowever, you would like to override that behavior you can use the `--format`\noption.\n\n# Release Notes\n\n<!-- towncrier-draft-entries:: Not yet released -->\n\n<!-- towncrier release notes start -->\n\n## 0.2.0 (2024-10-15)\n\n\n### \ud83d\udcd6 Documentation Enhancements\n\n- Converted the docs from ReStructuredText to markdown. [#6](https://github.com/mcflugen/logoizer/issues/6)\n- Modified towncrier to work with markdown rather than ReStructuredTxt. [#7](https://github.com/mcflugen/logoizer/issues/7)\n\n\n### \ud83d\udd29 Other Changes and Additions\n\n- Updated the linters and added several new ones. [#4](https://github.com/mcflugen/logoizer/issues/4)\n- Removed dependency on *click* (and *rich_click*) by moving to *argparse*. [#5](https://github.com/mcflugen/logoizer/issues/5)\n- Added a GitHub Actions *test* workflow. [#8](https://github.com/mcflugen/logoizer/issues/8)\n\n## 0.1.0 (2022-07-03)\n\n### \ud83c\udf70 New Features\n\n- Added the logize package for creating official CSDMS text-based logos. ([#1](https://github.com/mcflugen/logoizer/issues/1))\n\n### \ud83d\udd29 Other Changes and Additions\n\n- Changed the name of the project from *logoize* to *logoizer*. ([#2](https://github.com/mcflugen/logoizer/issues/2))\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Make CSDMS text logos",
"version": "0.2.0.post1",
"project_urls": {
"changelog": "https://github.com/mcflugen/logoizer/blob/main/CHANGES.md",
"documentation": "https://github.com/mcflugen/logoizer/blob/main/README.md",
"repository": "https://github.com/mcflugen/logoize"
},
"split_keywords": [
"csdms",
" logo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bfd22e019f72cc86c6a79a77c9efab6ae63a86c2a7ae52c9ab6ca07aaa29436",
"md5": "6a590618655da6d187e64c7a1f8159db",
"sha256": "5069bf1695fd4564e539855507a6ca903c9c08ba6b06460a803a28fc248c3f55"
},
"downloads": -1,
"filename": "logoizer-0.2.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "6a590618655da6d187e64c7a1f8159db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 272588,
"upload_time": "2024-10-16T05:36:51",
"upload_time_iso_8601": "2024-10-16T05:36:51.972508Z",
"url": "https://files.pythonhosted.org/packages/4b/fd/22e019f72cc86c6a79a77c9efab6ae63a86c2a7ae52c9ab6ca07aaa29436/logoizer-0.2.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 05:36:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mcflugen",
"github_project": "logoizer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "logoizer"
}
