Merge pull request #14 from claromes/docs

Docs

CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+### [0.3](https://github.com/claromes/volleystats/releases/tag/0.3) - Sep 23 2023
+
+- Change project name [@claromes](https://github.com/claromes) in [#13](https://github.com/claromes/volleystats/pull/13)
+
+### [0.2.1.1](https://github.com/claromes/volleystats/releases/tag/0.2.1.1) - Jun 1 2023
+
+- Fix setup by [@claromes](https://github.com/claromes) in [#12](https://github.com/claromes/volleystats/pull/12)
+
+### [v0.2.1](https://github.com/claromes/volleystats/releases/tag/v0.2.1) on Jun 1, 2023
+
+- [Update setup](https://github.com/claromes/volleystats/commit/b3be516bb5a431be46f18e02dfbebb82ce4c1710)
+
+### [v0.2](https://github.com/claromes/volleystats/releases/tag/v0.2) on Jun 1, 2023
+
+- Package and Docs by [@claromes](https://github.com/claromes) in [#10](https://github.com/claromes/volleystats/pull/10)
+
+### [v0.1.1](https://github.com/claromes/volleystats/releases/tag/v0.1.1) on Apr 4, 2023
+
+- Match List: fix XPath by [@claromes](https://github.com/claromes) in [#3](https://github.com/claromes/volleystats/pull/3)
+
+### [v0.1.0](https://github.com/claromes/volleystats/releases/tag/v0.1.0) on Apr 4, 2023
+
+- Add Match List by [@claromes](https://github.com/claromes) in [#1](https://github.com/claromes/volleystats/pull/1)
+- Update scripts by [@claromes](https://github.com/claromes) in [#2](https://github.com/claromes/volleystats/pull/2)
+
+### [v0.1.0-alpha](https://github.com/claromes/volleystats/releases/tag/v0.1.0-alpha) on Dec 19, 2022
+
+-  [Base code](https://github.com/claromes/volleystats/commits/v0.1.0-alpha)

LICENSE.md

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2023  Clarissa R Mendes
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <year>  <name of author>
+    volleystats  Copyright (C) 2023  Clarissa R Mendes
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -1,10 +1,11 @@
-# volleystats
+# Volley Stats
 
-[![PyPI](https://img.shields.io/pypi/v/volleystats)](https://pypi.org/project/volleystats/)
+[![PyPI](https://img.shields.io/pypi/v/volleystats)](https://pypi.org/project/volleystats/) [![License)](https://img.shields.io/github/license/claromes/volleystats)](https://github.com/claromes/volleystats/blob/main/LICENSE.md)
 
-`volleystats` is a CLI tool to get volleyball statistics from the Data Project Web Competition websites (WCM)
+CLI tool to get volleyball statistics from the Data Project Web Competition websites (WCM)
 
-**This tool is not affiliated with Data Project.**
+> [!IMPORTANT]
+> This tool is not affiliated with Genius Sports Company
 
 ## Requirements
 
@@ -32,37 +33,191 @@ ____________________|____-_ _|_______________,
   ',                         |                  ',
     ',                       |                    ',
       ',_____________________|______________________',
-	    volleystats
 
-volleystats: started!
+volleystats: started
 
 volleystats: data/1623_22-10-28_home_fluminense.csv file was created!
 
 volleystats: data/1623_22-10-28_guest_barueri-volleyball-club.csv file was created!
 
-volleystats: finished!
+volleystats: finished
 ```
 
+## CLI
+
+### Match
+
+>Stats of a match in separate files (home and guest).
+
+$ `volleystats --fed <Federation Acronym> --match <Match ID>`
+
+**Examples**
+
+- Brazilian Volleyball Confederation
+    - Data Project website: https://cbv-web.dataproject.com/MatchStatistics.aspx?mID=1623
+    - Federation Acronym: CBV
+    - Match ID: 1623
+    - Command: $ `volleystats --fed cbv --match 1623`
+    - Output files:
+        ```
+        data/1623_22-10-28_home_fluminense.csv
+        data/1623_22-10-28_guest_barueri-volleyball-club.csv
+        ```
+
+- Lithuanian Volleyball Federation
+    - Data Project website: https://lvf-web.dataproject.com/MatchStatistics.aspx?mID=2093
+    - Federation Acronym: LVF
+    - Match ID: 2093
+    - Command: $ `volleystats --fed lvf --match 2093`
+    - Output files:
+        ```
+        data/2093_2022-11-23_guest_jonavos-sc.csv
+        data/2093_2022-11-23_home_svaja-viktorija-lsu.csv
+        ```
+<br>
+
+### Competition Matches
+
+>List of matches in a competition.
+
+$ `volleystats --fed <Federation Acronym> --comp <Competition ID>`
+
+**Examples**
+
+- Brazilian Volleyball Confederation
+    - Data Project website: https://cbv-web.dataproject.com//CompetitionMatches.aspx?ID=18
+    - Federation Acronym: CBV
+    - Competition ID: 18
+    - Command: $ `volleystats --fed cbv --comp 18`
+    - Output files:
+        ```
+        data/18_competition_matches.csv
+        ```
+<br>
+
+### Help
+
+>Show help message.
+
+$ `volleystats --help`
+
+<br>
+
+## Federations and Leagues Acronym
+
+**European Volleyball**
+
+- `fshv`: Albanian Volleyball Federation
+- `osbih`: Bosnia and Herzegovina Volleyball Federation
+- `bvf`: Bulgarian Volleyball Federation
+- `bvl`: Baltic League
+- `vbl`: Bundesliga
+- `hos`: Croatian Volleyball Federation
+- `cvf`: Czech Volleyball Federation
+- `dvbf`: Danish Volleyball Federation
+- `evf`: Estonian Volleyball Federation
+- `fbf`: Faroe Islands Volleyball Association
+- `eope`: Hellenic Volleyball Federation
+- `hvf`: Hungary Volleyball Federation
+- `bli`: Icelandic Volleyball Association
+- `iva`: Israel Volleyball Association
+- `fipav`: Italian Volleyball Federation
+- `lvf`: Lithuanian Volleyball Federation
+- `mva`: Malta Volleyball Association
+- `nvbf`: Norwegian Volleyball Federation
+- `fpv`: Portuguese Volleyball Federation
+- `frv`: Romanian Volleyball Federation
+- `ossrb`: Serbian Volleyball Federation
+- `svf`: Slovak Volleyball Federation
+- `ozs`: Slovenian Volleyball Federation
+- `rfevb`: Spanish Volleyball Federation
+- `svbf`: Swedish Volleyball Federation
+- `swi`: Swiss Volley
+- `tvf`: Turkish Volleyball Federation
+- `pvlu`: Professional Volleyball League of Ukraine
+
+**South American Volleyball**
+
+- `feva`: Argentine Volleyball Federation
+- `cbv`: Brazilian Volleyball Confederation
+- `fcv`: Cordoba Volleyball Federation
+- `fpdv`: Peruvian Volleyball Federation
+
+## Main WCM endpoints
+
+- Base URL: `<Fed_Acronym>`-web.dataproject.com
+
+- Endpoins:
+    - /MainHome
+
+    - /History?ID=`<ID_Fed>`
+
+    - /CompetitionHome?ID=`<Category_ID>` (*could be female and male, pro or young*)
+
+    - /CompetitionMatches?ID=`<Competition_ID>`
+
+    - /MatchStatistics?mID=`Match_ID>`&`ID=Competition_ID>`
+
+## Available Page Locales
+
+- pt-BR
+- en-GB
+
 ## Available Data (WIP)
 
 - Competition
-    - Competition ID
-    - Home Team
-    - Guest Team
+    - [x] Competition ID
+    - [x] Home Team
+    - [x] Guest Team
+    - [ ] Home Points
+    - [ ] Guest Points
+    - [ ] Date
+    - [ ] Location
 
 - Match
-    - Match ID
-    - Match date
-    - Home Team
-    - Guest Team
+    - [x] Match ID
+    - [x] Match date
+    - [x] Home Team
+    - [x] Guest Team
+    - [ ] Coach
+    - [ ] Location
+    - [ ] Final result
+    - [ ] Result per SET
+
+- Vote
+    - [ ] Vote by player
 
 - Points
-    - Total Points by player
-    - Break Points by player
-    - Win-Lost by player
-    - Totals
-
-## [Documentation](https://openvb.github.io/volleystats)
+    - [x] Total Points by player
+    - [ ] Total Points by player per SET
+    - [x] Break Points by player
+    - [x] Win-Lost by player
+    - [x] Totals
+
+- Serve
+    - [ ] Total Serves by player
+    - [ ] Serve Erros by player
+    - [ ] Serve Points by player
+    - [ ] Totals
+
+- Reception
+    - [ ] Total Receptions by player
+    - [ ] Reception Erros by player
+    - [ ] Positive Pass Percentage by player
+    - [ ] Excellent/ Perfect Pass Percentage by player
+    - [ ] Totals
+
+- Attack
+    - [ ] Total Attacks by player
+    - [ ] Attack Erros by player
+    - [ ] Blocked Attack by player
+    - [ ] Attack Points by player
+    - [ ] Attack Points Percentage by player
+    - [ ] Totals
+
+- Block
+    - [ ] Block Points by player
+    - [ ] Totals
 
 ## Development
 
@@ -71,3 +226,11 @@ $ `git clone git@github.com:claromes/volleystats.git`
 $ `cd volleystats`
 
 $ `pip install -r requirements.txt`
+
+## License
+
+The package is licensed under the terms of the [GNU General Public License v3.0](LICENSE.md)
+
+## Author
+
+[Claromes](https://claromes.gitlab.io)