44 |
45 | Thanks to these amazing people
46 |
47 |
48 | 
49 |
50 |
--------------------------------------------------------------------------------
/CONTRIBUTION.md:
--------------------------------------------------------------------------------
1 | # Contributing Guidelines
2 |
3 | ## Opening an issue:
4 |
5 | Thank you for taking the time to open an issue.
6 |
7 | Before opening an issue, please be sure that your issue hasn't already been asked by someone.
8 |
9 | Here are a few things that will help us resolve your issues:
10 |
11 | - A descriptive title that gives an idea of what your issue refers to
12 | - A thorough description of the issue, (one word descriptions are very hard to understand)
13 | - Screenshots (if appropriate)
14 | - Links (if appropriate)
15 |
16 |
17 | ## Submitting a pull request:
18 |
19 | Follow the below mentioned steps to open a pull request(PR):
20 |
21 | #### If you don't have git on your machine, install it from [here](https://git-scm.com/downloads).
22 |
23 | ## Fork this repository
24 |
25 | Fork this repository by clicking on the fork button at the top of this page.
26 | This will create a copy of this repository in your account.
27 |
28 | ## Clone the repository
29 |
30 | Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
31 |
32 | Open a terminal and run the following git command:
33 |
34 | ```
35 | git clone "url you just copied"
36 | ```
37 |
38 | where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
39 |
40 | For example:
41 |
42 | ```
43 | git clone https://github.com/this-is-you/scout.git
44 | ```
45 |
46 | where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
47 |
48 | ## Create a branch
49 |
50 | Change to the repository directory on your computer (if you are not already there):
51 |
52 | ```
53 | cd scout
54 | ```
55 |
56 | Now create a branch using the `git switch` command:
57 |
58 | ```
59 | git switch -c your-new-branch-name
60 | ```
61 |
62 | For example:
63 |
64 | ```
65 | git switch -c improved-ui
66 | ```
67 |
68 | ## Make necessary changes and commit those changes
69 |
70 | If you go to the project directory and execute the command `git status`, you'll see there are changes.
71 |
72 | Add those changes to the branch you just created using the `git add` command:
73 |
74 | ```
75 | git add "filename with extention in which you have made changes"
76 | ```
77 |
78 | Now commit those changes using the `git commit` command:
79 |
80 | ```
81 | git commit -m "Add relavent message to the change you made"
82 | ```
83 |
84 | ## Push changes to GitHub
85 |
86 | Push your changes using the command `git push`:
87 |
88 | ```
89 | git push origin -u your-branch-name
90 | ```
91 |
92 | replacing `your-branch-name` with the name of the branch you created earlier.
93 |
94 | ## Submit your changes for review
95 |
96 | If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
97 |
98 | Now submit the pull request.
99 |
100 | Soon a reviewer will be merging all your changes into the main branch of this project. You will get a notification email once the changes have been merged.
101 |
102 | ## Note:
103 |
104 | PRs that exclusively add items to the list of domains will be classed as spam/invalid. We already grab this list from ICANN's complete list of certified registrars.
105 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | share/python-wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 | MANIFEST
28 |
29 | # PyInstaller
30 | # Usually these files are written by a python script from a template
31 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
32 | *.manifest
33 | *.spec
34 |
35 | # Installer logs
36 | pip-log.txt
37 | pip-delete-this-directory.txt
38 |
39 | # Unit test / coverage reports
40 | htmlcov/
41 | .tox/
42 | .nox/
43 | .coverage
44 | .coverage.*
45 | .cache
46 | nosetests.xml
47 | coverage.xml
48 | *.cover
49 | *.py,cover
50 | .hypothesis/
51 | .pytest_cache/
52 | cover/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | .pybuilder/
76 | target/
77 |
78 | # Jupyter Notebook
79 | .ipynb_checkpoints
80 |
81 | # IPython
82 | profile_default/
83 | ipython_config.py
84 |
85 | # pyenv
86 | # For a library or package, you might want to ignore these files since the code is
87 | # intended to run in multiple environments; otherwise, check them in:
88 | # .python-version
89 |
90 | # pipenv
91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
94 | # install all needed dependencies.
95 | #Pipfile.lock
96 |
97 | # poetry
98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99 | # This is especially recommended for binary packages to ensure reproducibility, and is more
100 | # commonly ignored for libraries.
101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102 | #poetry.lock
103 |
104 | # pdm
105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106 | #pdm.lock
107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108 | # in version control.
109 | # https://pdm.fming.dev/#use-with-ide
110 | .pdm.toml
111 |
112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113 | __pypackages__/
114 |
115 | # Celery stuff
116 | celerybeat-schedule
117 | celerybeat.pid
118 |
119 | # SageMath parsed files
120 | *.sage.py
121 |
122 | # Environments
123 | .env
124 | .venv
125 | env/
126 | venv/
127 | ENV/
128 | env.bak/
129 | venv.bak/
130 |
131 | # Spyder project settings
132 | .spyderproject
133 | .spyproject
134 |
135 | # Rope project settings
136 | .ropeproject
137 |
138 | # mkdocs documentation
139 | /site
140 |
141 | # mypy
142 | .mypy_cache/
143 | .dmypy.json
144 | dmypy.json
145 |
146 | # Pyre type checker
147 | .pyre/
148 |
149 | # pytype static type analyzer
150 | .pytype/
151 |
152 | # Cython debug symbols
153 | cython_debug/
154 |
155 | # PyCharm
156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158 | # and can be added to the global gitignore or merged into this file. For a more nuclear
159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder.
160 | #.idea/
161 |
162 |
163 | # Vim swap files
164 | *.swp
165 | .*.swp
166 | *~
167 | .*~
168 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | * Demonstrating empathy and kindness toward other people
21 | * Being respectful of differing opinions, viewpoints, and experiences
22 | * Giving and gracefully accepting constructive feedback
23 | * Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | * Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | * The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | * Trolling, insulting or derogatory comments, and personal or political attacks
33 | * Public or private harassment
34 | * Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | * Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | .
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
--------------------------------------------------------------------------------
/scout/main.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | from typing import Dict
3 |
4 | import requests
5 | import random
6 | import os
7 | import time
8 | import re
9 | import sys
10 | from datetime import datetime as dt
11 |
12 | from contextlib import contextmanager
13 | import argparse
14 | from rich.live import Live
15 | from rich.console import Console
16 | from rich.rule import Rule
17 | from rich.table import Table
18 | from rich.markdown import Markdown
19 |
20 | parser = argparse.ArgumentParser()
21 | parser.add_argument(
22 | '--standard', action='store_true', required=False,
23 | help='run the standard query for Python repos under 1k stars'
24 | )
25 |
26 | parser.add_argument(
27 | '--forks', action='store_true', required=False,
28 | help='show repos Forks'
29 | )
30 |
31 | parser.add_argument(
32 | '--nocolor', action='store_true', required=False,
33 | help='colors ommitted from output'
34 | )
35 |
36 | args = parser.parse_args()
37 | no_color = args.nocolor
38 | console = Console(no_color=no_color)
39 |
40 | TOKEN = os.getenv("SCOUT_TOKEN")
41 |
42 | # BASE_URL = "https://api.github.com/search/repositories?q=stars:%3E={}%20language:{}%20topic:hacktoberfest"
43 | BASE_URL = "https://api.github.com/search/repositories?q={}stars:%3C={}%20language:{}%20topic:hacktoberfest"
44 |
45 | def get_headers() -> dict[str, str]:
46 | if not TOKEN:
47 | print("You aren't using a Github token, this may result in ratelimits.")
48 | return {'Authorization': 'token ' + TOKEN if TOKEN else ""}
49 |
50 |
51 | def print_welcome_message() -> None:
52 | rule = Rule(
53 | '[b]Your personal opensource [purple]Scout',
54 | align="center",
55 | style="yellow"
56 | )
57 |
58 | console.print(rule)
59 | print("")
60 |
61 |
62 | def get_url():
63 | if args.standard:
64 | keyword = ''
65 | max_stars = '1000'
66 | lang = 'python'
67 | else:
68 | standard_style = "[purple]"
69 | keyword_style = "[purple]"
70 | star_style = "[blue]"
71 |
72 |
73 | try:
74 | standard = console.input(
75 | f"{standard_style}Shall I use the standard search which gets repos in the 1k stars range? \[y/n]: "
76 | )
77 | lang = console.input("Project language: \[python] ")
78 | keyword = console.input(
79 | f"{keyword_style}You can enter a keyword for the search: \[optional] "
80 | )
81 |
82 | except KeyboardInterrupt:
83 | print('\nFarewell my friend, beware the crickets.\n')
84 | sys.exit(1)
85 |
86 | else:
87 | if standard.lower() in ("y", "yes", ""):
88 | max_stars = 1000
89 | else:
90 | max_stars = int(
91 | console.input(
92 | f"{star_style}Star count range \[5-1000 is ideal]: "
93 | )
94 | )
95 |
96 | if lang == "":
97 | lang = "python"
98 |
99 | if keyword != "":
100 | keyword = f"{keyword} "
101 |
102 | url = BASE_URL.format(keyword, max_stars, lang)
103 | return url
104 |
105 |
106 | def request(url):
107 | page = random.randint(1, 3)
108 | response = requests.get(f"{url}&page={page}", headers=get_headers())
109 | status_code = response.status_code
110 |
111 | response_json = response.json()
112 |
113 | if response_json.get("items") is None:
114 | if status_code == 403:
115 | print("API rate limit exceeded, use the Github token")
116 | elif status_code == 401:
117 | print("GitHub Token invalid!")
118 | console.print(f"\n{str(response_json)}") # print response from gh api
119 | exit()
120 |
121 | return response_json
122 |
123 |
124 | def get_table_data(response: str) -> list:
125 | table_data = []
126 | for project in random.sample(response["items"], min(5, 29)):
127 | topics = "` `".join(project["topics"])
128 | topics = f"`{topics}`"
129 | topics = Markdown(topics, style="dim")
130 | stars = "{:,}".format(project["stargazers_count"])
131 | # stars = f":star: {stars}"
132 | issues = "{:,}".format(project["open_issues_count"])
133 | if args.forks:
134 | forks = project["forks"]
135 | project_time = project["updated_at"]
136 | # day = re.match(time, r"^[0-9]{4}-[0-9]{2}-[0-9]{2}")
137 | project_time = project_time[:10]
138 | project_time = dt.strptime(project_time, "%Y-%m-%d")
139 |
140 | if project_time.date() == dt.today().date():
141 | project_time = "Today"
142 | else:
143 | delta = dt.today().date() - project_time.date()
144 | if delta.days == 1:
145 | project_time = f"{str(delta.days)} day"
146 | else:
147 | project_time = f"{str(delta.days)} days"
148 | project_name = project['full_name']
149 | row = [
150 | project_name, project["description"],
151 | str(stars), str(issues), topics, project_time
152 | ]
153 | if args.forks:
154 | row.insert(4, str(forks))
155 |
156 | table_data.append(
157 | row
158 | )
159 | return table_data
160 |
161 | def create_table(table):
162 | table.add_column("Project", header_style="bold cyan", style="bold cyan")
163 | table.add_column("Description", header_style="bold green", style="italic green")
164 | table.add_column("Stars", header_style="bold yellow", style="yellow")
165 | table.add_column("Issues", header_style="bold grey66", style="grey66")
166 | if args.forks:
167 | table.add_column("Forks", header_style="bold dark_orange", style="dark_orange")
168 | table.add_column("Tags", header_style="bold")
169 | table.add_column("Last updated", header_style="red bold", style="red")
170 |
171 |
172 | def display_table(table_data):
173 | table = Table(padding=(0, 1, 1, 1))
174 | create_table(table)
175 | table.add_row(*table_data[0])
176 | with Live(table, console=console, refresh_per_second=4):
177 | for row in table_data[1:]:
178 | table.add_row(*row)
179 | time.sleep(0.5)
180 |
181 |
182 | def cli() -> None:
183 | print_welcome_message()
184 | url = get_url()
185 | console.clear()
186 | response = request(url)
187 | table_data = get_table_data(response)
188 | display_table(table_data)
189 |
190 |
191 | if __name__ == "__main__":
192 | cli()
193 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
675 |
--------------------------------------------------------------------------------
7 | Before opening an issue, please be sure that your issue hasn't already been asked by someone. 8 |
9 | Here are a few things that will help us resolve your issues: 10 | 11 | - A descriptive title that gives an idea of what your issue refers to 12 | - A thorough description of the issue, (one word descriptions are very hard to understand) 13 | - Screenshots (if appropriate) 14 | - Links (if appropriate) 15 |
16 | 17 | ## Submitting a pull request: 18 | 19 | Follow the below mentioned steps to open a pull request(PR): 20 | 21 | #### If you don't have git on your machine, install it from [here](https://git-scm.com/downloads). 22 | 23 | ## Fork this repository 24 | 25 | Fork this repository by clicking on the fork button at the top of this page. 26 | This will create a copy of this repository in your account. 27 | 28 | ## Clone the repository 29 | 30 | Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. 31 | 32 | Open a terminal and run the following git command: 33 | 34 | ``` 35 | git clone "url you just copied" 36 | ``` 37 | 38 | where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. 39 | 40 | For example: 41 | 42 | ``` 43 | git clone https://github.com/this-is-you/scout.git 44 | ``` 45 | 46 | where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer. 47 | 48 | ## Create a branch 49 | 50 | Change to the repository directory on your computer (if you are not already there): 51 | 52 | ``` 53 | cd scout 54 | ``` 55 | 56 | Now create a branch using the `git switch` command: 57 | 58 | ``` 59 | git switch -c your-new-branch-name 60 | ``` 61 | 62 | For example: 63 | 64 | ``` 65 | git switch -c improved-ui 66 | ``` 67 | 68 | ## Make necessary changes and commit those changes 69 | 70 | If you go to the project directory and execute the command `git status`, you'll see there are changes. 71 | 72 | Add those changes to the branch you just created using the `git add` command: 73 | 74 | ``` 75 | git add "filename with extention in which you have made changes" 76 | ``` 77 | 78 | Now commit those changes using the `git commit` command: 79 | 80 | ``` 81 | git commit -m "Add relavent message to the change you made" 82 | ``` 83 | 84 | ## Push changes to GitHub 85 | 86 | Push your changes using the command `git push`: 87 | 88 | ``` 89 | git push origin -u your-branch-name 90 | ``` 91 | 92 | replacing `your-branch-name` with the name of the branch you created earlier. 93 | 94 | ## Submit your changes for review 95 | 96 | If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. 97 | 98 | Now submit the pull request. 99 | 100 | Soon a reviewer will be merging all your changes into the main branch of this project. You will get a notification email once the changes have been merged. 101 | 102 | ## Note: 103 | 104 | PRs that exclusively add items to the list of domains will be classed as spam/invalid. We already grab this list from ICANN's complete list of certified registrars. 105 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | 162 | 163 | # Vim swap files 164 | *.swp 165 | .*.swp 166 | *~ 167 | .*~ 168 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | . 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | -------------------------------------------------------------------------------- /scout/main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | from typing import Dict 3 | 4 | import requests 5 | import random 6 | import os 7 | import time 8 | import re 9 | import sys 10 | from datetime import datetime as dt 11 | 12 | from contextlib import contextmanager 13 | import argparse 14 | from rich.live import Live 15 | from rich.console import Console 16 | from rich.rule import Rule 17 | from rich.table import Table 18 | from rich.markdown import Markdown 19 | 20 | parser = argparse.ArgumentParser() 21 | parser.add_argument( 22 | '--standard', action='store_true', required=False, 23 | help='run the standard query for Python repos under 1k stars' 24 | ) 25 | 26 | parser.add_argument( 27 | '--forks', action='store_true', required=False, 28 | help='show repos Forks' 29 | ) 30 | 31 | parser.add_argument( 32 | '--nocolor', action='store_true', required=False, 33 | help='colors ommitted from output' 34 | ) 35 | 36 | args = parser.parse_args() 37 | no_color = args.nocolor 38 | console = Console(no_color=no_color) 39 | 40 | TOKEN = os.getenv("SCOUT_TOKEN") 41 | 42 | # BASE_URL = "https://api.github.com/search/repositories?q=stars:%3E={}%20language:{}%20topic:hacktoberfest" 43 | BASE_URL = "https://api.github.com/search/repositories?q={}stars:%3C={}%20language:{}%20topic:hacktoberfest" 44 | 45 | def get_headers() -> dict[str, str]: 46 | if not TOKEN: 47 | print("You aren't using a Github token, this may result in ratelimits.") 48 | return {'Authorization': 'token ' + TOKEN if TOKEN else ""} 49 | 50 | 51 | def print_welcome_message() -> None: 52 | rule = Rule( 53 | '[b]Your personal opensource [purple]Scout', 54 | align="center", 55 | style="yellow" 56 | ) 57 | 58 | console.print(rule) 59 | print("") 60 | 61 | 62 | def get_url(): 63 | if args.standard: 64 | keyword = '' 65 | max_stars = '1000' 66 | lang = 'python' 67 | else: 68 | standard_style = "[purple]" 69 | keyword_style = "[purple]" 70 | star_style = "[blue]" 71 | 72 | 73 | try: 74 | standard = console.input( 75 | f"{standard_style}Shall I use the standard search which gets repos in the 1k stars range? \[y/n]: " 76 | ) 77 | lang = console.input("Project language: \[python] ") 78 | keyword = console.input( 79 | f"{keyword_style}You can enter a keyword for the search: \[optional] " 80 | ) 81 | 82 | except KeyboardInterrupt: 83 | print('\nFarewell my friend, beware the crickets.\n') 84 | sys.exit(1) 85 | 86 | else: 87 | if standard.lower() in ("y", "yes", ""): 88 | max_stars = 1000 89 | else: 90 | max_stars = int( 91 | console.input( 92 | f"{star_style}Star count range \[5-1000 is ideal]: " 93 | ) 94 | ) 95 | 96 | if lang == "": 97 | lang = "python" 98 | 99 | if keyword != "": 100 | keyword = f"{keyword} " 101 | 102 | url = BASE_URL.format(keyword, max_stars, lang) 103 | return url 104 | 105 | 106 | def request(url): 107 | page = random.randint(1, 3) 108 | response = requests.get(f"{url}&page={page}", headers=get_headers()) 109 | status_code = response.status_code 110 | 111 | response_json = response.json() 112 | 113 | if response_json.get("items") is None: 114 | if status_code == 403: 115 | print("API rate limit exceeded, use the Github token") 116 | elif status_code == 401: 117 | print("GitHub Token invalid!") 118 | console.print(f"\n{str(response_json)}") # print response from gh api 119 | exit() 120 | 121 | return response_json 122 | 123 | 124 | def get_table_data(response: str) -> list: 125 | table_data = [] 126 | for project in random.sample(response["items"], min(5, 29)): 127 | topics = "` `".join(project["topics"]) 128 | topics = f"`{topics}`" 129 | topics = Markdown(topics, style="dim") 130 | stars = "{:,}".format(project["stargazers_count"]) 131 | # stars = f":star: {stars}" 132 | issues = "{:,}".format(project["open_issues_count"]) 133 | if args.forks: 134 | forks = project["forks"] 135 | project_time = project["updated_at"] 136 | # day = re.match(time, r"^[0-9]{4}-[0-9]{2}-[0-9]{2}") 137 | project_time = project_time[:10] 138 | project_time = dt.strptime(project_time, "%Y-%m-%d") 139 | 140 | if project_time.date() == dt.today().date(): 141 | project_time = "Today" 142 | else: 143 | delta = dt.today().date() - project_time.date() 144 | if delta.days == 1: 145 | project_time = f"{str(delta.days)} day" 146 | else: 147 | project_time = f"{str(delta.days)} days" 148 | project_name = project['full_name'] 149 | row = [ 150 | project_name, project["description"], 151 | str(stars), str(issues), topics, project_time 152 | ] 153 | if args.forks: 154 | row.insert(4, str(forks)) 155 | 156 | table_data.append( 157 | row 158 | ) 159 | return table_data 160 | 161 | def create_table(table): 162 | table.add_column("Project", header_style="bold cyan", style="bold cyan") 163 | table.add_column("Description", header_style="bold green", style="italic green") 164 | table.add_column("Stars", header_style="bold yellow", style="yellow") 165 | table.add_column("Issues", header_style="bold grey66", style="grey66") 166 | if args.forks: 167 | table.add_column("Forks", header_style="bold dark_orange", style="dark_orange") 168 | table.add_column("Tags", header_style="bold") 169 | table.add_column("Last updated", header_style="red bold", style="red") 170 | 171 | 172 | def display_table(table_data): 173 | table = Table(padding=(0, 1, 1, 1)) 174 | create_table(table) 175 | table.add_row(*table_data[0]) 176 | with Live(table, console=console, refresh_per_second=4): 177 | for row in table_data[1:]: 178 | table.add_row(*row) 179 | time.sleep(0.5) 180 | 181 | 182 | def cli() -> None: 183 | print_welcome_message() 184 | url = get_url() 185 | console.clear() 186 | response = request(url) 187 | table_data = get_table_data(response) 188 | display_table(table_data) 189 | 190 | 191 | if __name__ == "__main__": 192 | cli() 193 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc.