Datasets:
File size: 5,063 Bytes
6de9681 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# Volunteering help for KTISEOS NYX projects
[__Promotion and Docs__](#promotion-and-docs)<br>
[__Setting up For Development__](#setting-up-for-development)<br>
[__Contributing Code__](#contributing-code)<br>
[__Previous Builds__](#previous-builds)<br>
## Promotion And Docs
We're always looking for help with:
- Video Tutorials
- Documenting
- Feature Ideas
- Aesthetic Suggestions
- Design Discussion
- New Code
Coordinate with us by:
- Opening a topic in [discussions](https://github.com/Ktiseos-Nyx/Dataset-Tools/discussions/new/choose)
- Opening an [issue](https://github.com/Ktiseos-Nyx/Dataset-Tools/issues/new/choose)
- Connect with us live on discord!
<a href="https://discord.gg/5t2kYxt7An" target="_blank">
&color=rgb(65%2C69%2C191))
</a>
## Contributing Code
### Specifications :
> #### Formatting/Linting Specification
> ```
> editor = Visual Studio Code
> formatting = Ruff/Black/Better Align
> docstrings = NumPY/Sphinx
> installation = setuptools
> testing = pytest
> typing = Pydantic
> ui = QT
> ```
> #### Variable dictionary
> ```
> # Actions
> Delegate / Arrange / Direct / Traffic / Filter / Coordinate / Assign
> Fetch / Get / Extract / Pull / Send / Feed / Push
> Delineate / Format / Detail / Cat|Concat / Show / Join / Splice
> Diverge / Unite / Resolve / Generate / Activate
> Identify / Compare / Detect / Measure / Scan / Scrutinize
> Log / Cache / Read / Load / Capture / Populate / Save
> Test / Interpret / Poll / Interrogate / Flag / Mark / Mask / Trace
> Protect / Register / Ignore / Canonize
> Check / Validate / Normalize
> Advance / Skip / Exit / Leave / Cross / Structure / Fold
> # Conditions
> Raw / Upstream / Downstream / Up / Down / Low / High
> Active / Passive / Inactive / Public / Private
> Extrinsic / Intrinsic / Static / Dynamic / Valid / Invalid
> Indirect / Direct / Pending / Next
> Maybe / Local / Remote / Persistent / Relevant
> # Object
> File / Folder / Fragment / Component / Segment
> Header/ Content / Pattern / Target / Aspect
> State / Signal / Trigger / Level / Status / Attribute
> Location / Path / Parameter / Code / Mask
> Net / Disk
> # Between bits
> Is / Has / Can
> # File and Folder handling
> file_contents = data inside the file
> file_name = exclusively
> file_path = the path leading up to the file, with no file name
> file_path_named = relative or absolute path including name
> empty_file_name = a file to be created
> empty_file_name_and_path = relative or absolute path including name to be created
> folder_contents = file names inside a folder
> folder_name = the name of the folder
> folder_name_and_path = relative or absolute path including name
> empty_folder_name = a folder to be created
> empty_folder_name_and_path = relative or absolute path including name to be created
> # Key and Value handling
> key_name
> key_name_and_path
> empty_key_name
> empty_key_name_and_path
> value_name
> value_name_and_path
> empty_key_name
> empty_key_name_and_path
> new_key_name
> ```
## Setting Up For Development
These are the instructions to follow for people who want to build the app with us!
### Dev Installation:
> ```
> pip install -e .[dev]
> ```
### Update version:
> ```
> python -m _version
> ```
>
### Run with debug logging :
> ```
> dataset-tools -d
> ```
> or
> ```
> python -m main --log debug
> ```
### Reinstallation:
> ```
> pip uninstall dataset-tools
> ```
## Previous Builds
### Where we started from
Here you can see some screenshots of previous versions of the application. Look at our baby pics! 🍼
<img width="797" alt="Screenshot of the Application" src="https://github.com/user-attachments/assets/7e14c542-482d-42f4-a9ae-4305c9e2c383">
<img width="459" alt="Screenshot 2024-06-14 at 22 00 40" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/9dc7f859-13d5-4e75-9f21-171648b3061e">
<img width="464" alt="Screenshot 2024-06-14 at 22 09 01" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/dbfd0678-aff4-47f2-a23f-e7cfa14582ef">
<img width="1202" alt="Screenshot 2024-06-15 at 00 03 47" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/a2e1b5bb-7ffc-43e9-8002-56aa977478f6">
<img width="1198" alt="Screenshot 2024-06-15 at 00 03 55" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/8f948d75-96ae-4ae7-b87b-0ad8887e6745">
<img width="1678" alt="Screenshot 2024-06-15 at 00 04 16" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/bba4d2a7-9aaa-42f3-82f8-b866db8f0084">
<img width="1183" alt="Screenshot 2024-06-15 at 14 06 00" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/a513f6df-1fca-421b-ae8b-401abc7741cb">
<img width="1190" alt="Screenshot 2024-06-15 at 15 01 45" src="https://github.com/duskfallcrew/Dataset-Tools/assets/58930427/10d386f8-ae21-4672-964c-5d4ebc889275">
|