Metadata-Version: 2.1
Name: viking-log-keeper
Version: 0.9.0
Summary: 661 VGS - Function to collate 2965D log sheets into a master log, database, and dashboard.
License: MIT
Author: Michael Jennings
Author-email: mjennings061@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: inquirer (>=3.2.0,<4.0.0)
Requires-Dist: keyring (>=24.3.0,<25.0.0)
Requires-Dist: logging (>=0.4.9.6,<0.5.0.0)
Requires-Dist: matplotlib (>=3.8.0,<4.0.0)
Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
Requires-Dist: pandas (>=2.2.0,<3.0.0)
Requires-Dist: pymongo[srv] (>=4.6.1,<5.0.0)
Requires-Dist: streamlit (>=1.32.0,<2.0.0)
Requires-Dist: xlsxwriter (>=3.2.0,<4.0.0)
Project-URL: homepage, https://github.com/mjennings061/viking-log-keeper
Project-URL: repository, https://github.com/mjennings061/viking-log-keeper.git
Description-Content-Type: text/markdown

# Log Keeper
661 VGS - Function to collate 2965D log sheets into a single master log file and database.

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/cd4929e4-7a13-4d48-b4b6-1cd52f865b8d)

## Contents

1. [Installation](#installation)
2. [Usage](#usage)
3. [Contribution](#contribution)
4. [Support](#support)
5. [License](#license)

## Installation
1. Ensure [Python 3.11](https://www.python.org/downloads/windows/) is installed and `python.exe` is [added to the path](https://realpython.com/add-python-to-path/):

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/f2d58a92-752c-426e-878f-832cfcf7e175)

2. Sync your squadron sharepoint using OneDrive:

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/e9c856aa-48c3-429d-9685-d3b586538ea2)

3. Create a directory on your sharepoint in documents called `Log Sheets`. The naming is important!

4. Save the `2965D_YYMMDD_ZEXXX.xlsx` template (See `docs/`) into the `#Statistics/Log Sheets` directory. 

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/ea8e51e0-ee2b-481a-88ce-63a544e0da1b)

5. Get started with creating some log sheets to test it out. Note, you will need to update the hidden `INPUT_DATA` sheet to add your aircraft and pilots:

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/0b826db1-fbf1-43e0-b07a-389521f9f697)

6. Sign up to [MongoDB Atlas](https://cloud.mongodb.com) to create your organisation, project, database, and collection. It is free for 512 MB. An example below:
- Organisation: RAFAC VGS
- Project: 661 VGS
- Database: 661vgs
- Collection: log_sheets

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/a2991958-93c2-45c7-9406-8dbe913c32c2)

7. Using powershell, git bash, or command prompt, run the following command:

```bash
python -m pip install viking-log-keeper
```

## Usage

### Normal Usage

1. Following installation, run the log keeper function:

```bash
update-logs
```

2. Enter the credentials of your database. The URL can be found in the "Database > Overview > Connect" menu:

![image](https://github.com/mjennings061/viking-log-keeper/assets/24479573/7b91cde7-aa26-4bc3-8f85-5c37893aceee)

### Debugging

1. To update your database configuration, run the following command:

```bash
update-config
```

2. To update your log sheet location, run the following command:

```bash
update-log-sheet-location
```

## Contribution

- Issue Tracker: https://github.com/mjennings061/viking-log-keeper/issues
- Source Code: https://github.com/mjennings061/viking-log-keeper/tree/main

## Support

For questions and assistance, consider raising an issue on the [issue tracker](https://github.com/mjennings061/viking-log-keeper/issues). All other queries can be directed to [mjennings061@gmail.com]()

## License

The project is licensed under the MIT License.

