FAQ.md

FAQ

The FAQ is in progress. Reach out if you have any unanswered questions or concerns.

---

Question: Does GitHub Trends have access to my private code contributions?

Answer: GitHub Trends requires an OAuth access token to make requests on your behalf. The standard public workflow creates a token with read-only access to strictly public information. This access token can not view or edit any private contributions.

Alternatively, users can use the private workflow which creates a token with read and write access to private information. Although GitHub Trends only uses it's read access, GitHub does not allow read-only private access (see an open issue from 2015). While one may scan the repository to confirm this statement, there are inherent security risks to this overallocation. If this poses an issue to you, please use the public workflow instead.

Question: How can I display my images side by side?

Answer: Use HTML (credit: github-readme-stats)

<a href="https://githubtrends.io">
  <img align="center" src="https://api.githubtrends.io/user/svg/avgupta456/langs" />
</a>
<a href="https://githubtrends.io">
  <img align="center" src="https://api.githubtrends.io/user/svg/avgupta456/repos" />
</a>

Question: How can I see my stats without giving GitHub Trends my access token?

Answer: You will need to run the code locally. Clone the repository, navigate to the backend folder, install the dependencies (pip install -r requirements.txt), and then run the following script:

python ./scripts/local.py --user_id=USER_ID --access_token=ACCESS_TOKEN --start_date=2023-01-01 --end_date=2023-01-31 --output_dir=OUTPUT_DIR

The script will output the raw and processed JSONs into the output directory specified.

Question: What if I find a bug, or want to contribute?

Answer: Raise an issue or pull request through GitHub. I would be happy to discuss and implement any suggestions or improvements.