<commit_before>Shotter
===================

Shotter is a simple project I started after having some troubles with the captured app for macOS. The upload "API" *(uploader.php)* included is a minimal re-write of the [Captured-php](https://github.com/csexton/captured-php) script for [Captured](http://www.capturedapp.com).

upload.py will automatically upload the specified image to the server you have the /uploaded.php file located on. It will perform basic authentication and if successfully authenticated and if the file has been successfully uploaded, return the public link to the file and copy if to your clip board.

Since I'm an Apple geek it will currently only work on macOS.


To do
-------------

>**Features**

 > -  Make the command line arguments prettier/easier to use.
 > -  Create a GUI app or make the script watch certain folders for file changes and automatically upload.
 > - By doing the above hopefully make the project easier to use for non-tech savy users.
 > - Add automatic copying of link to clip-board on linux too.
 > - Make the code more pretty and easier to add to/modify.
 > - More awesomeness.

Installation
-------------

**uploader.php**
>**Step 1**
>Upload uploader.php to your web-root.
>
>**Step 2**
>Make sure apache/nginx has write access to the folder.

**upload.py**
> **Step 1**
> Make sure the shebang `#!/usr/bin/env python3` is added at the top of upload.py.
>
> **Step 2**
> Make the file executable: `chmod -x upload.py`
>
>**Step 3**
> Rename the file so we can get rid of the .py part. `mv upload.py upload`
>
> **Step 4**
> Create a folder to hold your personal scripts: `mkdir -p ~/bin`
> Copy upload.py to the newly created folder: `cp upload.py ~/.bin`
> Add export `PATH=$PATH":$HOME/bin"` to your .profile or .bash_profile.
> Test it out by typing `uploader -f [path_to_file]`


Usage
-------------

> **Command(s)**
> *upload -f [path_to_file]*
<commit_msg>fixed spelling and formatting errors in README.md<commit_after>Shotter
===================

Shotter is a simple project I started after having some troubles with the captured app for macOS. The upload "API" *(uploader.php)* included is a minimal re-write of the [Captured-php](https://github.com/csexton/captured-php) script for [Captured](http://www.capturedapp.com).

upload.py will automatically upload the specified image to the server where you have uploaded uploaded.php. It will perform basic authentication and upload the image, if succeded in both, it will return the public link to the file and copy if to your clip board.

Since I'm an Apple geek it will currently only work on macOS.


To do
-------------
 > -  Make the command line arguments prettier/easier to use.
 > -  Create a GUI app or make the script watch certain folders for file changes and automatically upload.
 > - By doing the above hopefully make the project easier to use for non-tech savy users.
 > - Add automatic copying of link to clip-board on linux too.
 > - Make the code more pretty and easier to add to/modify.
 > - More awesomeness.

Installation
-------------

**uploader.php**
>**Step 1**
>Upload uploader.php to your web-root.
>
>**Step 2**
>Make sure apache/nginx has write access to the folder.

**upload.py**
> **Step 1**
> Make sure the shebang `#!/usr/bin/env python3` is added at the top of upload.py.
>
> **Step 2**
> Create a folder to hold your personal executables. `mkdir -p ~/bin`. If you already have a preferred folder for this, you can skip this step.
>
>**Step 3**
> Copy upload.py either to ~/bin or to your preferred folder.
>
>**Step 4**
> Make upload.py executable `chmod +x upload.py`.
> 
> **Step 5**
> Rename the file so we can get rid of the .py part. `mv upload.py upload`
>
> **Step 6**
> Add `export PATH=$PATH":$HOME/bin"` to your .profile or .bash_profile file.
> Now restart your shell and type `upload -f [path-to-file]`


Usage
-------------

> **Command(s)**
> *upload -f [path-to-file]*

{'fraction_non_alphanumeric': 0.1292949860015271, 'fraction_numerical': 0.004072283023670145, 'mean_word_length': 3.4965675057208236, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 62, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2383704', 'n_tokens_mistral': 1207, 'n_tokens_neox': 1149, 'n_words': 548}