ghisa


Nameghisa JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://alexandregazagnes.github.io/ghisa/
Summaryghisa is a GitHub Import Stats Analyzer for pythonistas
upload_time2024-02-16 21:49:40
maintainerAlexandreGazagnes
docs_urlNone
authorAlexandreGazagnes
requires_python==3.10.12
licenseBSD-3-Clause
keywords python git tool utils github stats analyzer import export data analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <!-- ![image](./docs/assets/img/image.png) -->
<!-- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -->
![Python](https://img.shields.io/badge/python-3.10.x-green.svg)
![Repo Size](https://img.shields.io/github/repo-size/AlexandreGazagnes/ghisa)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
<!-- ![Coverage](https://github.com/AlexandreGazagnes/ghisa/blob/main/docs/assets/img/cov.svg?raw=true) -->
![Tests](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/tests.yaml/badge.svg)
![Statics](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/statics.yaml/badge.svg)
![Doc](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/docs.yaml/badge.svg)
![Pypi](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/publish.yaml/badge.svg)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/AlexandreGazagnes/ghisa)

# ghisa - Github Import Statistic Analyzer 

## About
ghisa is a free and open-source software, app and python package that allows that helps you to analyze the import statistics of your github repositories.

## Key Features

Main features of ghisa are:
- Import statistics of your github repositories
- Import statistics of your github profile

## Installation

Using regular pip and venv tools :

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install ghisa
```

## Usage


### Local


#### As executable

In a terminal :
* ```ghisa repo [my-github-repo] ``` standard usage


* ```ghisa repo -f my_file.txt [my-github-repo]  ``` specify a file list output

* ```ghisa profile [profile-name] ``` specify a profile name and output



#### As library

In a terminal :

```python
from ghisa import Repo, Profile

repo_url  = "https://github.com/AlexandreGazagnes/ghisa"

repo = Repo(repo_url)
print(repo)

# or

profile_name = "AlexandreGazagnes"
profile = Profile(profile_name)
print(profile)
```

#### As local web app

In a terminal :


* ```ghisa gui ``` launch local streamlit

### On line

* The on line web app is temporarily unavailable. It will be available in the `0.1.0` release.


## Documentation

Please visit [Documentation](https://alexandregazagnes.github.io/ghisa/) page.


## Updates


Please visit the 
- [Changelog](https://alexandregazagnes.github.io/ghisa/changelog) page 
- [Roadmap](https://github.com/AlexandreGazagnes/ghisa/projects?query=is%3Aopen) page
- [Release](https://github.com/AlexandreGazagnes/ghisa/releases) page
- [Issues](https://github.com/AlexandreGazagnes/ghisa/issues) page


## Contributing

ghisa is an open-source project and we are always looking for more people to contribute to its development.

It could be by adding new features, fixing bugs, improving the documentation, or any other way you see fit.

Any help is welcome, and we will do our best to help you get started.

Any feedback is also welcome.

Please visit [Contributing](https://alexandregazagnes.github.io/ghisa/contributing) page.

            

Raw data

            {
    "_id": null,
    "home_page": "https://alexandregazagnes.github.io/ghisa/",
    "name": "ghisa",
    "maintainer": "AlexandreGazagnes",
    "docs_url": null,
    "requires_python": "==3.10.12",
    "maintainer_email": "alex@gazagnes.net",
    "keywords": "python,git,tool,utils,github,stats,analyzer,import,export,data,analysis",
    "author": "AlexandreGazagnes",
    "author_email": "alex@gazagnes.net",
    "download_url": "https://files.pythonhosted.org/packages/33/e8/e3e4164d7fb6670f9f98e5e791f57ee1da4c2b243f42c3318d8a6f044509/ghisa-0.0.1.tar.gz",
    "platform": null,
    "description": "<!-- ![image](./docs/assets/img/image.png) -->\n<!-- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -->\n![Python](https://img.shields.io/badge/python-3.10.x-green.svg)\n![Repo Size](https://img.shields.io/github/repo-size/AlexandreGazagnes/ghisa)\n[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n<!-- ![Coverage](https://github.com/AlexandreGazagnes/ghisa/blob/main/docs/assets/img/cov.svg?raw=true) -->\n![Tests](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/tests.yaml/badge.svg)\n![Statics](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/statics.yaml/badge.svg)\n![Doc](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/docs.yaml/badge.svg)\n![Pypi](https://github.com/AlexandreGazagnes/ghisa/actions/workflows/publish.yaml/badge.svg)\n![GitHub commit activity](https://img.shields.io/github/commit-activity/m/AlexandreGazagnes/ghisa)\n\n# ghisa - Github Import Statistic Analyzer \n\n## About\nghisa is a free and open-source software, app and python package that allows that helps you to analyze the import statistics of your github repositories.\n\n## Key Features\n\nMain features of ghisa are:\n- Import statistics of your github repositories\n- Import statistics of your github profile\n\n## Installation\n\nUsing regular pip and venv tools :\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install ghisa\n```\n\n## Usage\n\n\n### Local\n\n\n#### As executable\n\nIn a terminal :\n* ```ghisa repo [my-github-repo] ``` standard usage\n\n\n* ```ghisa repo -f my_file.txt [my-github-repo]  ``` specify a file list output\n\n* ```ghisa profile [profile-name] ``` specify a profile name and output\n\n\n\n#### As library\n\nIn a terminal :\n\n```python\nfrom ghisa import Repo, Profile\n\nrepo_url  = \"https://github.com/AlexandreGazagnes/ghisa\"\n\nrepo = Repo(repo_url)\nprint(repo)\n\n# or\n\nprofile_name = \"AlexandreGazagnes\"\nprofile = Profile(profile_name)\nprint(profile)\n```\n\n#### As local web app\n\nIn a terminal :\n\n\n* ```ghisa gui ``` launch local streamlit\n\n### On line\n\n* The on line web app is temporarily unavailable. It will be available in the `0.1.0` release.\n\n\n## Documentation\n\nPlease visit [Documentation](https://alexandregazagnes.github.io/ghisa/) page.\n\n\n## Updates\n\n\nPlease visit the \n- [Changelog](https://alexandregazagnes.github.io/ghisa/changelog) page \n- [Roadmap](https://github.com/AlexandreGazagnes/ghisa/projects?query=is%3Aopen) page\n- [Release](https://github.com/AlexandreGazagnes/ghisa/releases) page\n- [Issues](https://github.com/AlexandreGazagnes/ghisa/issues) page\n\n\n## Contributing\n\nghisa is an open-source project and we are always looking for more people to contribute to its development.\n\nIt could be by adding new features, fixing bugs, improving the documentation, or any other way you see fit.\n\nAny help is welcome, and we will do our best to help you get started.\n\nAny feedback is also welcome.\n\nPlease visit [Contributing](https://alexandregazagnes.github.io/ghisa/contributing) page.\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "ghisa is a GitHub Import Stats Analyzer for pythonistas",
    "version": "0.0.1",
    "project_urls": {
        "Changelog": "https://alexandregazagnes.github.io/ghisa/CHANGELOG/",
        "Documentation": "https://alexandregazagnes.github.io/ghisa/",
        "Homepage": "https://alexandregazagnes.github.io/ghisa/",
        "Issues": "https://github.com/AlexandreGazagnes/ghisa/issues",
        "Repository": "https://github.com/AlexandreGazagnes/ghisa/tree/main"
    },
    "split_keywords": [
        "python",
        "git",
        "tool",
        "utils",
        "github",
        "stats",
        "analyzer",
        "import",
        "export",
        "data",
        "analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45597d71f81bdc34bff996690ab8c2f5502648ed073c46df9e3f5827d3bafc7d",
                "md5": "4c5bc03053186deb4be46720b535c530",
                "sha256": "5120bf54395c3527d1b0d50bb2c133af1023baed233d2c41fa53bd52e0619b8c"
            },
            "downloads": -1,
            "filename": "ghisa-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c5bc03053186deb4be46720b535c530",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "==3.10.12",
            "size": 45321,
            "upload_time": "2024-02-16T21:49:38",
            "upload_time_iso_8601": "2024-02-16T21:49:38.273468Z",
            "url": "https://files.pythonhosted.org/packages/45/59/7d71f81bdc34bff996690ab8c2f5502648ed073c46df9e3f5827d3bafc7d/ghisa-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "33e8e3e4164d7fb6670f9f98e5e791f57ee1da4c2b243f42c3318d8a6f044509",
                "md5": "048f6d807cb43bff5904e52f8c6e4342",
                "sha256": "ce5bdb56d94c2f9dbc8354d4bf2664b6e6daa934c5deab06e5daa78d9da3cfd2"
            },
            "downloads": -1,
            "filename": "ghisa-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "048f6d807cb43bff5904e52f8c6e4342",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "==3.10.12",
            "size": 39712,
            "upload_time": "2024-02-16T21:49:40",
            "upload_time_iso_8601": "2024-02-16T21:49:40.151384Z",
            "url": "https://files.pythonhosted.org/packages/33/e8/e3e4164d7fb6670f9f98e5e791f57ee1da4c2b243f42c3318d8a6f044509/ghisa-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-16 21:49:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AlexandreGazagnes",
    "github_project": "ghisa",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ghisa"
}
        
Elapsed time: 1.32636s