Metadata-Version: 2.1
Name: hydrozincite
Version: 0.1.1
Summary: Hydrozincite - Zn₅(CO₃)₂(OH)₆
Keywords: git static
Author-Email: HS-157 <hs-157@lett.re>
License: Copyright (c) 2020, HS-157
        
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
        this list of conditions and the following disclaimer in the documentation
        and/or other materials provided with the distribution.
        
        This software is provided by the copyright holders and contributors "as is"
        and any express or implied warranties, including, but not limited to, the
        implied warranties of merchantability and fitness for a particular purpose
        are disclaimed. In no event shall the copyright holder or contributors be
        liable for any direct, indirect, incidental, special, exemplary, or
        consequential damages (including, but not limited to, procurement of
        substitute goods or services; loss of use, data, or profits; or business
        interruption) however caused and on any theory of liability, whether in
        contract, strict liability, or tort (including negligence or otherwise)
        arising in any way out of the use of this software, even if advised of the
        possibility of such damage.
Project-URL: Repository, https://forge.dotslashplay.it/HS-157/Hydrozincite
Requires-Python: >=3.11
Requires-Dist: rich>=13.5.2
Requires-Dist: GitPython>=3.1.36
Requires-Dist: Jinja2>=3.1.2
Description-Content-Type: text/markdown

# Hydrozincite - Zn₅(CO₃)₂(OH)₆

A simple static page generator for Git repositories.

## Installation

### PyPI

You can find on [PyPI](https://pypi.org/project/hydrozincite/) and install via your favorite package installer for Python, like [pip](https://pypi.org/project/pip/).

```bash
python3 -m pip install hydrozincite
```

### Source

From source, need [build](https://pypi.org/project/build/) & [pdm-backend](https://pypi.org/project/pdm-backend/) as build dependencies.

```bash
python3 -m build --wheel
```

And install via your favorite package installer.

```
python3 -m pip install dist/*.whl
```

Or directly via [pdm](https://pdm.fming.dev).

```bash
pdm install
```

### Archlinux

On Archlinux, via the PKGBUILD file.

```bash
cd PKGBUILD
makepkg -scri
```

## Usage

You can show help via `hydrozincite --help`.

```bash
# Genereate HTML page
hydrozincite --repositories "<path>" --output "<path>" --clone-url "<url>"
# Show info on your repositories
hydrozincite info
# Show info on repository hooks
hydrozincite hook
# Write hooks on your repositories
hydrozincite hook --write
```

It's possoble use a config file from 
`./hydrozincite.toml`, `$XDG_CONFIG_HOME/hydrozincite/config.toml`, `~/.config/hydrozincite/config.toml`, `/etc/hydrozincite/config.toml"` or via `--conf <path>` parameter.

```toml
title = "Awesome git repositories !"
clone_url = "https://git.foo.bar"

[bare]
path = "<path>"

[render]
output = "<path>"
template = "<path>"
theme = "default"
```

## Contributing

* See [CONTRIBUTING.md](CONTRIBUTING.md)


## License

* [BSD 2-clause "Simplified" License](LICENSE)

## Mirrors

* [forge.dotslashplay.it](https://forge.dotslashplay.it/HS-157/Hydrozincite) (source)
* [git.lett.re](https://git.lett.re/#Hydrozincite)

# Feedback

I take any constructive feedback to improves the project. You can find my email [here](CONTRIBUTING.md).
