Skip to content

Commit

Permalink
update: download instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
metaist committed Dec 31, 2023
1 parent 58f9e26 commit c63daa9
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## castfit: basic type casting
# castfit: basic type casting

<p align="center">
<a href="https://metaist.github.io/castfit/"><img alt="castfit" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
<em>Do you even castfit?<br />If it fits, I sits.</em>
<a href="https://metaist.github.io/castfit/"><img alt="Cuddles the Cat" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
<em>Cuddles the Cat<br />
"If it fits, I sits."</em>
</p>
<p align="center">
<a href="https://github.com/metaist/castfit/actions/workflows/ci.yaml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&logo=github"/></a>
Expand All @@ -24,6 +25,8 @@ I'm writing more and more type-checked code, but I often get a bunch of strings
python -m pip install castfit
```

Alternatively, you can just [download the single file](https://raw.githubusercontent.com/metaist/castfit/main/src/castfit/__init__.py) and name it `castfit.py`.

## Example

```python
Expand Down
Empty file added docs/.nojekyll
Empty file.
12 changes: 4 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,14 @@ <h1 class="title">Package <code>castfit</code></h1>
<section id="section-intro">
<p>castfit: basic type casting</p>
<p align="center">
<a href="https://metaist.github.io/castfit/"><img alt="castfit" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
<em>Do you even castfit?<br />If it fits, I sits.</em>
<a href="https://metaist.github.io/castfit/"><img alt="Cuddles the Cat" width="200" src="https://raw.githubusercontent.com/metaist/castfit/main/cats-fit.png" /></a><br />
<em>Cuddles the Cat<br />
"If it fits, I sits."</em>
</p>
<p align="center">
<a href="https://github.com/metaist/castfit/actions/workflows/ci.yaml"><img alt="Build" src="https://img.shields.io/github/actions/workflow/status/metaist/castfit/.github/workflows/ci.yaml?branch=main&logo=github"/></a>
<!-- <a href="https://github.com/metaist/castfit/issues"><img alt="Issues" src="https://img.shields.io/github/issues/metaist/castfit?logo=github"/></a> -->
<!-- <br /> -->
<a href="https://pypi.org/project/castfit"><img alt="PyPI" src="https://img.shields.io/pypi/v/castfit.svg?color=blue" /></a>
<a href="https://pypi.org/project/castfit"><img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/castfit" /></a>
<!-- <br />
<a href="https://metaist.github.io/castfit/"><img alt="Docs" src="https://img.shields.io/badge/docs-read-%2" /></a>
<a href="https://github.com/metaist/castfit/blob/main/CHANGELOG.md"><img alt="Changelog" src="https://img.shields.io/badge/changelog-read-%2"></a>
<a href="https://github.com/metaist/castfit/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/metaist/castfit" /></a> -->
</p>
<h2 id="why">Why?</h2>
<p>I'm writing more and more type-checked code, but I often get a bunch of strings I need to convert (e.g., from <a href="https://github.com/docopt/docopt"><code>docopt</code></a>).</p>
Expand All @@ -48,6 +43,7 @@ <h2 id="why">Why?</h2>
<h2 id="install">Install</h2>
<pre><code class="language-bash">python -m pip install castfit
</code></pre>
<p>Alternatively, you can just <a href="https://raw.githubusercontent.com/metaist/castfit/main/src/castfit/__init__.py">download the single file</a> and name it <code>castfit.py</code>.</p>
<h2 id="example">Example</h2>
<pre><code class="language-python">from pathlib import Path
from castfit import castfit
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ docs = { shell = """\
--config show_inherited_members=True \
--force src/$(basename $(pwd));
mv docs/**/* docs/
touch docs/.nojekyll
""" }

lint = { composite = ["black", "ruff", "cspell", "pyright", "mypy"] }
Expand Down

0 comments on commit c63daa9

Please sign in to comment.