Skip to content

Add Initial Documentation and Contributor Guide for Youtool Project #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 115 commits into
base: develop
Choose a base branch
from
Open

Add Initial Documentation and Contributor Guide for Youtool Project #12

wants to merge 115 commits into from

Conversation

aninhasalesp
Copy link

Description:

  • Adds initial documentation for the youtool project, following the Read the Docs standard for easy documentation hosting and maintenance.
  • Includes a contributor guide with instructions on setting up a development environment, running tests, and updating documentation.

turicas and others added 30 commits September 12, 2024 17:15
@turicas @aninhasalesp
Add console_scripts to setup.cfg
2ecbda4
@turicas @aninhasalesp
Implement draft CLI module
252ff46
@turicas @aninhasalesp
Add old/draft CLI search code
dcc9e2f
@turicas @aninhasalesp
Add useful scripts (to be added to utils and CLI)
f2540a8
@aninhasalesp
- Add argparse integration and command handling for Youtube CLI Tool
079e5ee
@aninhasalesp
- Implemented method to extract URLs from a CSV file;
4c5d151 
- Implemented  method to convert a list of dictionaries into a CSV file or string;
@aninhasalesp
- Implemented command to extract YouTube channel IDs from a list of U…
943f6b0 
…RLs or a CSV file containing URLs;

- Added commands directory structure
@aninhasalesp
- Added to the list;
b4f82e5
@aninhasalesp
Update cli.py
525015e 
fix: show error with parser if not in debug mode
@aninhasalesp
- Removed the type annotation from the method;
4fba6d4 
- Changed file path passing to use  from  in the  method;
@aninhasalesp
- Add changed the method signature in the class to accept (**kwargs) …
2ba79df 
…and return a string;

- Added logic to convert values retrieved from the CSV file to strings before appending them to the data list;
@aninhasalesp
- Fixed typing error in all in the file.
8ab5185
@aninhasalesp
Add updates docstrings
6b28320
@aninhasalesp
Update import
dfc2011
@aninhasalesp
Add update command into the file
b1b3367
@aninhasalesp
Add update
28b2574
@aninhasalesp
Add improvements to the file
fe180fb
@aninhasalesp
Add test for cli file
d4e66b4
@aninhasalesp
Add test for base file
4bf29ff
@aninhasalesp
Add test for channel_id command
216e5f2
@aninhasalesp
add docstrings
1b335b7
@aninhasalesp
- Implement ChannelInfo class to fetch YouTube channel information fr…
c5ad8fd 
…om URLs, usernames, or CSV files containing them;

- Add  method to filter channel information based on specified columns;
- Define  method to handle the command logic, including reading input, fetching channel data, and saving to CSV;
- Support for various input methods including direct URLs/usernames and file paths for CSV input;
- Support for specifying output CSV file path and columns to include in the output.
@aninhasalesp
- Included ChannelInfo in the list of commands in COMMANDS.
e718d4a
@aninhasalesp
Add updates docstrings
7dc7b8d
@aninhasalesp
Add updates docstrings
ed012e5
@aninhasalesp
- Add updates
9a5fe66
@aninhasalesp
- Add updates
8ba47cf
@aninhasalesp
- Add test for channel_info command;
c08e4ec 
- Add update channel_info file;
- fix test_base
@aninhasalesp
add docstrings
a5bb13d
@aninhasalesp
fix
923170e
aninhasalesp and others added 25 commits September 18, 2024 12:23
@aninhasalesp
Fix
264b311
@aninhasalesp
- Add test for channel_info command;
7ed6840 
- Add update channel_info file;
- fix test_base
@aninhasalesp
- Add test for video_search command;
1f30a9b 
- Add updates to some test files;
- created conftest file
@aninhasalesp
- Add test for video_transcription command;
088b3f0 
- Add some necessary improvements in other files
@aninhasalesp
add poetry
d00b97b
@aninhasalesp
add updates poetry config
0644cb3
@aninhasalesp
add dependencie
e5e232f
@turicas @aninhasalesp
Implement draft CLI module
6e46679
@aninhasalesp
Add test for base file
2dd9e25
@aninhasalesp
Add update
8281c7d
@aninhasalesp
- Add test for channel_info command;
3249990 
- Add update channel_info file;
- fix test_base
@aninhasalesp
- Add test for video_search command;
8e33465 
- Add updates to some test files;
- created conftest file
@aninhasalesp
add github actions
50ac1b4
@aninhasalesp
add updates github actions
9817382
@aninhasalesp
fix
b252ef8
@aninhasalesp
fix
1c8a087
@aninhasalesp
fix
32487ad
@aninhasalesp
fix
6c6575c
@aninhasalesp
fix
6af4f31
@turicas @aninhasalesp
Implement draft CLI module
8223267
@aninhasalesp
- Add test for channel_info command;
98ea4d0 
- Add update channel_info file;
- fix test_base
@aninhasalesp
- Add test for video_search command;
03dbcd4 
- Add updates to some test files;
- created conftest file
@aninhasalesp
add github actions
ffbccff
@aninhasalesp
add file readthedocs config
37d2a75
@aninhasalesp
implementing read the docs config
ca1d94b
@aninhasalesp aninhasalesp changed the base branch from feature/cli to develop September 19, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aninhasalesp @turicas