Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 4.39 KB

README.md

File metadata and controls

111 lines (86 loc) · 4.39 KB
Raw
whois
open issues version license

Helping communities to become more connected.
Built with love • Brought to you by @hurfy and other contributors

Introduction

GitHub is a wonderful place. It is a social network that is not like any other. When you build your projects here together with other people, you feel like anything is possible. But unlike other networks where you have a direct communication channel with your fans or followers, here, you are very limited. Our mission is to change that.

We've built this small project with the hope of improving our lives as developers. We believe we can achieve our mission by creating tools that allow opening up a new communication channel with the fans and creating a lifeline between you as the author of your product and your fans, people who starred, watched, and contributed to your project.

This project's only purpose is to be an informational guide, a small community building block, a stepping stone, if you will.

How it works

When you run it, it will scan your project and will try its best to return you a list of fans of your project and a way for you to connect with them. The speed of execution depends on the size of your project and amount of fans it has.

This list will be in JSON and/or CSV format, depending on the settings you've choosen.

Note: Any information generated by this software package has only informational purposes. It must not be used for any other activities that might be considered unethical, including unsolicited communication attempts and/or spam.

Quick Start

Access Token

First of all, you need to create a GitHub Access Token, with all permissions for repositories and users.

Download

Clone the repository:

git clone git@github.com:faqtly/whois.git

Install all requirements:

pip install -r requirements.txt

Environment

Now you need to set up the application configuration, specify the repository and your GitHub Access Token. You can either create your own .env file or use .env.example. Be sure to specify the number of repositories to be checked for each user. The higher the value, the better the result. It is recommended to set the value in the range of 5-10.

*don't forget to remove .example :)

Environment example:

GITHUB_TOKEN=ghp_exampleToken1234567890
GITHUB_REPO=faqtly/whois
REPOS_COUNT=5

All done! Now you can launch the app!

python main.py

Examples:

After that an output folder will be generated, which will contain files with data obtained from your repository.

\output
    \repo
        repo_users.json # List of all users(URLs)
        repo.json       # End result
        repo.csv        # End result

JSON example:

{
    "user123": {
        "name": "John Doe",
        "email": "johndoe@example.com",
        "website": "www.johndoe.com",
        "location": null,
        "company": null
    },
    "janesmth": {
        "name": "Jane Smith",
        "email": "janesmith@example.com",
        "website": null,
        "location": "Los Angeles, USA",
        "company": "XYZ Corporation"
    }
}

Contributing

Contributions are highly welcomed and encouraged. Please feel free to fork the repository, make the improvements, and create a Pull Request to this repository for our review.

License

For the licensing information, please check out our LICENSE.