hydrozincite

Name	hydrozincite JSON
Version	0.1.3 JSON
	download
home_page
Summary	Hydrozincite - Zn₅(CO₃)₂(OH)₆
upload_time	2024-02-26 18:03:41
maintainer
docs_url	None
author
requires_python	>=3.11
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.
keywords	git static
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 possible 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](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/CONTRIBUTING.md)


## License

* [BSD 2-clause "Simplified" License](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/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](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/CONTRIBUTING.md).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "hydrozincite",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "git static",
    "author": "",
    "author_email": "HS-157 <hs-157@lett.re>",
    "download_url": "https://files.pythonhosted.org/packages/c6/05/938f663d8d629e6cbc900057a1ca0e320406f5ded80b586aa981d01485dd/hydrozincite-0.1.3.tar.gz",
    "platform": null,
    "description": "# Hydrozincite - Zn\u2085(CO\u2083)\u2082(OH)\u2086\n\nA simple static page generator for Git repositories.\n\n## Installation\n\n### PyPI\n\nYou 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/).\n\n```bash\npython3 -m pip install hydrozincite\n```\n\n### Source\n\nFrom source, need [build](https://pypi.org/project/build/) & [pdm-backend](https://pypi.org/project/pdm-backend/) as build dependencies.\n\n```bash\npython3 -m build --wheel\n```\n\nAnd install via your favorite package installer.\n\n```\npython3 -m pip install dist/*.whl\n```\n\nOr directly via [pdm](https://pdm.fming.dev).\n\n```bash\npdm install\n```\n\n### Archlinux\n\nOn Archlinux, via the PKGBUILD file.\n\n```bash\ncd PKGBUILD\nmakepkg -scri\n```\n\n## Usage\n\nYou can show help via `hydrozincite --help`.\n\n```bash\n# Genereate HTML page\nhydrozincite --repositories \"<path>\" --output \"<path>\" --clone-url \"<url>\"\n# Show info on your repositories\nhydrozincite info\n# Show info on repository hooks\nhydrozincite hook\n# Write hooks on your repositories\nhydrozincite hook --write\n```\n\nIt's possible use a config file from \n`./hydrozincite.toml`, `$XDG_CONFIG_HOME/hydrozincite/config.toml`, `~/.config/hydrozincite/config.toml`, `/etc/hydrozincite/config.toml\"` or via `--conf <path>` parameter.\n\n```toml\ntitle = \"Awesome git repositories !\"\nclone_url = \"https://git.foo.bar\"\n\n[bare]\npath = \"<path>\"\n\n[render]\noutput = \"<path>\"\ntemplate = \"<path>\"\ntheme = \"default\"\n```\n\n## Contributing\n\n* See [CONTRIBUTING.md](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/CONTRIBUTING.md)\n\n\n## License\n\n* [BSD 2-clause \"Simplified\" License](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/LICENSE)\n\n## Mirrors\n\n* [forge.dotslashplay.it](https://forge.dotslashplay.it/HS-157/Hydrozincite) (source)\n* [git.lett.re](https://git.lett.re/#Hydrozincite)\n\n# Feedback\n\nI take any constructive feedback to improves the project. You can find my email [here](https://forge.dotslashplay.it/HS-157/Hydrozincite/-/blob/master/CONTRIBUTING.md).\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2020, HS-157\n        \n        All rights reserved.\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        1. Redistributions of source code must retain the above copyright notice,\n        this list of conditions and the following disclaimer.\n        \n        2. Redistributions in binary form must reproduce the above copyright notice,\n        this list of conditions and the following disclaimer in the documentation\n        and/or other materials provided with the distribution.\n        \n        This software is provided by the copyright holders and contributors \"as is\"\n        and any express or implied warranties, including, but not limited to, the\n        implied warranties of merchantability and fitness for a particular purpose\n        are disclaimed. In no event shall the copyright holder or contributors be\n        liable for any direct, indirect, incidental, special, exemplary, or\n        consequential damages (including, but not limited to, procurement of\n        substitute goods or services; loss of use, data, or profits; or business\n        interruption) however caused and on any theory of liability, whether in\n        contract, strict liability, or tort (including negligence or otherwise)\n        arising in any way out of the use of this software, even if advised of the\n        possibility of such damage.",
    "summary": "Hydrozincite - Zn\u2085(CO\u2083)\u2082(OH)\u2086",
    "version": "0.1.3",
    "project_urls": {
        "Repository": "https://forge.dotslashplay.it/HS-157/Hydrozincite"
    },
    "split_keywords": [
        "git",
        "static"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "33b364955e0089182524d3393dbb88a93a9754da9e71783f22219665e51f967f",
                "md5": "def3e715aac7167d42da5b6725424438",
                "sha256": "538bbf2b19689af0d6b887030767f5fb8410fa9a590db68951aae839ccbfa138"
            },
            "downloads": -1,
            "filename": "hydrozincite-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "def3e715aac7167d42da5b6725424438",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 9963,
            "upload_time": "2024-02-26T18:03:35",
            "upload_time_iso_8601": "2024-02-26T18:03:35.172613Z",
            "url": "https://files.pythonhosted.org/packages/33/b3/64955e0089182524d3393dbb88a93a9754da9e71783f22219665e51f967f/hydrozincite-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c605938f663d8d629e6cbc900057a1ca0e320406f5ded80b586aa981d01485dd",
                "md5": "e0d96902da448389ad7fa9db10d88acf",
                "sha256": "7a573ed3ae9d7af915482b98a3d00c232addc34afe8151ea340abc212cd5a33f"
            },
            "downloads": -1,
            "filename": "hydrozincite-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e0d96902da448389ad7fa9db10d88acf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 16825,
            "upload_time": "2024-02-26T18:03:41",
            "upload_time_iso_8601": "2024-02-26T18:03:41.749355Z",
            "url": "https://files.pythonhosted.org/packages/c6/05/938f663d8d629e6cbc900057a1ca0e320406f5ded80b586aa981d01485dd/hydrozincite-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-26 18:03:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "hydrozincite"
}