https://github.com/mareksuchanek/repocribro
Extensible sifting tool for information from GitHub repositories
https://github.com/mareksuchanek/repocribro
community github project python-3 share sieve web-application
Last synced: 8 months ago
JSON representation
Extensible sifting tool for information from GitHub repositories
- Host: GitHub
- URL: https://github.com/mareksuchanek/repocribro
- Owner: MarekSuchanek
- License: mit
- Created: 2016-12-03T09:21:53.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-08T07:50:40.000Z (over 3 years ago)
- Last Synced: 2025-10-12T00:05:14.660Z (8 months ago)
- Topics: community, github, project, python-3, share, sieve, web-application
- Language: Python
- Size: 565 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
repocribro
==========
|license| |docs| |pypi| |requires|
Repocribro is web application allowing users to register their GitHub repository so they can
be managed, searched, browsed, tested, etc. (depends on used extensions) with the site. Main
idea is to provide simple but powerful modular tool for building groups of GitHub repositories
which are developed by different users and organizations.
*Cribro* means sieve in `Italian language`_ (origins in Latin word *cribrum*). This project
provides tool for intelligent sifting repositories, information about them and its contents.
Typical use cases of Repocribro:
- **Community** - repositories hub of examples / projects related to the community (methodology,
standards, ...)
- **Courses** - gathering and evaluating homeworks
Installation and usage
----------------------
Installation is done via standard way by ``setup.py`` file, alternatively you can install
by ``pip`` but there are just major releases and bugfixed versions. You need to have Python
3.5+ (tested with 3.5 and 3.6), all dependencies will be installed automatically.
::
$ python setup.py install
$ repocribro --version
$ repocribro --help
You can also setup virtual Python environment before installation:
::
$ python -venv env
$ . env/bin/activate
(env) $ python3 setup.py install
For running the application you will need to set up the configuration with GitHub client ID and
secret, security keys, database and so on.
For details please visit `repocribro.readthedocs.io`_.
Bugs, ideas, extensions and experience
--------------------------------------
If you find any bug, get any idea or have any experience with **Repocribro** - let us know via
`issues@GitHub`_. **Repocribro** is extensible, if you are developing any extension or have an
idea for some new extension, let us know via `issues@GitHub`_ too. Please use a corresponding
label.
For details please visit `repocribro.readthedocs.io`_ and `wiki@GitHub`_.
Docker Compose
--------------
To make use of ``docker-compose.yml``, you need to adjust configuration based on ``docker-config.example.cfg`` and also create the database:
::
$ docker exec -it repocribro_db_1 mysql -u root -p
Enter password:
mysql> CREATE DATABASE repocribro;
mysql> exit
Bye
$ docker exec -it repocribro_repocribro_1 repocribro db_create
License
-------
This project is licensed under the MIT License - see the `LICENSE`_ file for more details.
.. _Italian language: https://en.wiktionary.org/wiki/cribro
.. _repocribro.readthedocs.io: http://repocribro.readthedocs.io/en/latest/
.. _wiki@GitHub: https://github.com/MarekSuchanek/repocribro/wiki
.. _issues@GitHub: https://github.com/MarekSuchanek/repocribro/issues
.. _LICENSE: LICENSE
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: LICENSE
.. |docs| image:: https://readthedocs.org/projects/pyt-twitterwall/badge/?version=latest
:alt: Documentation Status
:target: http://repocribro.readthedocs.io/en/latest/?badge=latest
.. |pypi| image:: https://badge.fury.io/py/repocribro.svg
:alt: PyPi Version
:target: https://badge.fury.io/py/repocribro
.. |requires| image:: https://requires.io/github/MarekSuchanek/repocribro/requirements.svg?branch=develop
:alt: Requirements Status
:target: https://requires.io/github/MarekSuchanek/repocribro/requirements/?branch=develop