Merge pull request bepasty#336 from ThomasWaldmann/typos-grammar

fix typos and grammar

Author: ThomasWaldmann

.github/workflows/ci.yml

@@ -70,7 +70,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
       with:
-        # just fetching 1 commit is not enough for setuptools-scm, so we fetch all
+        # Fetching only the latest commit is not enough for setuptools-scm; fetch full history
         fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
@@ -80,7 +80,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip setuptools wheel
         pip install -r requirements.d/dev.txt
-    - name: run pytest via tox
+    - name: Run pytest via tox
       run: |
         tox --skip-missing-interpreters
     - name: Upload coverage to Codecov

MANIFEST.in

@@ -1,4 +1,4 @@
-# stuff we need to include into the sdist is handled automatically by
-# setuptools_scm - it includes all git-committed files.
-# but we want to exclude some committed files/dirs not needed in the sdist:
+# The files to include in the sdist are handled automatically by
+# setuptools_scm — it includes all Git-committed files.
+# However, we want to exclude some committed files/dirs not needed in the sdist:
 exclude .gitattributes .gitignore .github

docs/source/index.rst

@@ -1,9 +1,9 @@
-Welcome to bepasty's documentation!
+Welcome to Bepasty’s documentation!
 ===================================
 
-bepasty is like a pastebin for every kind of file (text, image, audio, video, documents, ...).
+Bepasty is like a pastebin for every kind of file (text, image, audio, video, documents, …).
 
-You can upload multiple files at once, simply by drag and drop.
+You can upload multiple files at once by simply dragging and dropping them.
 
 Contents
 --------

docs/source/install-tutorial.rst

@@ -1,24 +1,24 @@
 
 =====================================================
-Installation tutorial with Debian, NGinx and gunicorn
+Installation tutorial with Debian, Nginx and Gunicorn
 =====================================================
 
-preliminary packages:
+Preliminary packages:
 
 ::
 
   apt-get install build-essential nginx supervisor python-dev git-core python-pip python-virtualenv
 
 
-commands to run
+Commands to run
 
 ::
 
   # add user bepasty to system
   adduser bepasty
   # change to user bepasty
   sudo su - bepasty
-  # clone repository from github
+  # clone repository from GitHub
   git clone https://github.com/bepasty/bepasty-server.git repo
   # create folder for storage
   mkdir storage
@@ -34,20 +34,20 @@ commands to run
   # add gunicorn and gevent for hosting
   pip install gunicorn gevent
 
-config file for bepasty -- ``/home/bepasty/bepasty.conf``:
+Config file for Bepasty — ``/home/bepasty/bepasty.conf``:
 
 Copy ``src/bepasty/config.py`` to ``/home/bepasty/bepasty.conf`` first,
 remove the ``class Config`` and remove all indents in the file.
 The comments can be removed too, if you feel the need to.
-At last modify these two configs variables:
+Finally, modify these two configuration variables:
 
 ::
 
   STORAGE = 'filesystem'
   STORAGE_FILESYSTEM_DIRECTORY = '/home/bepasty/storage/'
 
 
-add this content to ``/home/bepasty/bin/gunicorn_bepasty``:
+Add this content to ``/home/bepasty/bin/gunicorn_bepasty``:
 
 ::
 
@@ -74,7 +74,7 @@ add this content to ``/home/bepasty/bin/gunicorn_bepasty``:
 
 Make it executable: ``chmod +x ~/bin/gunicorn_bepasty``
 
-A nginx configuration i.e. in ``/etc/nginx/conf.d/bepasty.conf``:
+An Nginx configuration, e.g., in ``/etc/nginx/conf.d/bepasty.conf``:
 
 ::
 
@@ -102,7 +102,7 @@ A nginx configuration i.e. in ``/etc/nginx/conf.d/bepasty.conf``:
     }
   }
 
-Now reload your nginx configuration: `service nginx reload`.  
+Now reload your Nginx configuration: `service nginx reload`.
 
 Supervisord config i.e. in ``/etc/supervisor/conf.d/bepasty.conf``:
 
@@ -114,4 +114,4 @@ Supervisord config i.e. in ``/etc/supervisor/conf.d/bepasty.conf``:
   stdout_logfile = /home/bepasty/logs/gunicorn_supervisor.log   ; Where to write log messages
   redirect_stderr = true                                        ; Save stderr in the same log
 
-Finally reload supervisor: `service supervisor reload`
+Finally, reload supervisor: `service supervisor reload`

docs/source/project.rst

@@ -1,11 +1,11 @@
 ============================
-The bepasty software Project
+The Bepasty Software Project
 ============================
 
 History
 =======
 
-The initial version of the bepasty(-server) software was developed in 48h in the WSGI Wrestle 2013 contest by:
+The initial version of the Bepasty (-server) software was developed in 48 hours during the WSGI Wrestle 2013 contest by:
 
 * `Bastian Blank <[email protected]>`_
 * `Christian Fischer <[email protected]>`_
@@ -14,8 +14,7 @@ The initial version of the bepasty(-server) software was developed in 48h in the
 Project site
 ============
 
-Source code repository, issue tracker (bugs, ideas about enhancements, todo,
-feedback, ...), link to documentation is all there:
+Source code repository, issue tracker (bugs, enhancement ideas, to-dos, feedback, …), and a link to the documentation are all there:
 
 https://github.com/bepasty/
 
@@ -25,11 +24,11 @@ Contributing
 
 Feedback is welcome.
 
-If you find some issue, have some idea or some patch, please submit them via the issue tracker.
+If you find an issue, have an idea, or a patch, please submit it via the issue tracker.
 
-Or even better: if you use git, fork our repo, make your changes and submit a pull request.
+Or, even better: if you use Git, fork our repo, make your changes, and submit a pull request.
 
-For small fixes, you can even just edit the files on github (github will then fork, change and submit a pull request
+For small fixes, you can even just edit the files on GitHub (GitHub will then fork, change, and submit a pull request
 automatically).
 
 Development
@@ -41,12 +40,12 @@ Development
     virtualenv bepasty-server-env
     # Activate the virtualenv
     source bepasty-server-env/bin/activate
-    # Clone the official bepasty-server (or your fork, if you want to send PULL requests)
+    # Clone the official bepasty-server (or your fork, if you want to send pull requests)
     git clone https://github.com/bepasty/bepasty-server.git
     cd bepasty-server
     # This will use the current directory for the installed package.
-    # Very useful during development! It will also autoreload when files are changed
+    # Very useful during development! It will also auto-reload when files are changed.
     pip install -e .
-    # Run the bepasty-server in debug mode. The server is reachable in http://127.0.0.1:5000
+    # Run the Bepasty server in debug mode. The server is reachable at http://127.0.0.1:5000
     bepasty-server --debug
 

docs/source/quickstart.rst

@@ -1,23 +1,23 @@
 Quickstart
 ==========
 
-Installing bepasty
+Installing Bepasty
 ------------------
 
-You can install bepasty either from PyPi (latest release) or from the git repository (latest available code).
+You can install Bepasty either from PyPI (latest release) or from the Git repository (latest available code).
 
 ::
 
-    # from PyPi:
+    # from PyPI:
     pip install bepasty
 
-    # if you'ld like to have python-magic to help determining files' mime types, use:
+    # if you'd like to have python-magic help determine files' MIME types, use:
     pip install bepasty[magic]
 
-    # from git repo
+    # from Git repository
     pip install -e git+https://github.com/bepasty/bepasty-server.git#egg=bepasty-server
 
-Configuring bepasty
+Configuring Bepasty
 -------------------
 Before you can use bepasty, you need to carefully configure it (it won't work in default configuration and most of
 the configuration settings need your attention).
@@ -34,7 +34,7 @@ Here is the documentation straight from its config:
 To create a local and non-default configuration, copy ``bepasty/config.py`` to e.g. ``/srv/bepasty/bepasty.conf``
 first, remove the ``class Config`` and remove all indents in the file.
 The comments can be removed too, if you feel the need to.
-At last modify these two configs variables: then modify it:
+Finally, modify these configuration variables:
 
 ::
 
@@ -58,7 +58,7 @@ Important notes:
   http).
 
 
-Starting bepasty server
+Starting the Bepasty server
 -----------------------
 
 You can run the bepasty server with your local configuration by pointing to it via the BEPASTY_CONFIG
@@ -73,9 +73,9 @@ Important note:
 * Use an absolute path as value for BEPASTY_CONFIG.
 
 
-The builtin WSGI server is recommended only for development and non-production use.
+The built-in WSGI server is recommended only for development and non-production use.
 
-For production, you should use a WSGI server like gunicorn, apache+mod-wsgi, nginx+uwsgi, etc.
+For production, you should use a WSGI server like Gunicorn, Apache + mod_wsgi, Nginx + uWSGI, etc.
 
 ::
 
@@ -85,7 +85,7 @@ For production, you should use a WSGI server like gunicorn, apache+mod-wsgi, ngi
 Invoking CLI commands
 ---------------------
 
-All bepasty commands expect either a --config <configfilename> argument or that the BEPASTY_CONFIG environment
+All Bepasty commands expect either a --config <configfilename> argument or that the BEPASTY_CONFIG environment
 variable points to your configuration file.
 
 The "object" command operates on objects stored in the storage. You can get infos about them ("info" subcommand),

docs/source/rest.rst

@@ -1,9 +1,9 @@
 ========================
-Using bepasty's REST-API
+Using Bepasty’s REST API
 ========================
 
-The Rest-API enables you to upload and download files, as well as
-retrieve informations about the file on the server.
+The REST API enables you to upload and download files, as well as
+retrieve information about the file on the server.
 
 Currently the REST API provides the following API Endpoints::
 
@@ -20,14 +20,14 @@ Currently the REST API provides the following API Endpoints::
 
 Authentication
 ==============
-For endpoints that require non-default permissions, authentication can be done through http basic authentication. The user is ignored and the password is the key for the intended permissions.
+For endpoints that require non-default permissions, authentication can be done through HTTP Basic authentication. The user is ignored and the password is the key for the intended permissions.
 
 Errors
 ======
-The error response from REST-API will set ``Content-Type:
-application/json``, and body as JSON format like the following
-example. (it was previously ``Content-Type: text/html; charset=utf-8``
-and partial HTML page or plain string)
+The error response from the REST API will set ``Content-Type:
+application/json``, and the body as JSON in the following
+format. (It was previously ``Content-Type: text/html; charset=utf-8``
+and a partial HTML page or a plain string.)
 
 Example::
 
@@ -56,20 +56,20 @@ GET Response by the server:
           MAX_BODY_SIZE: 1048576
         }
 
-    This interface will give you important infos for uploading and
-    downloading files to your bepasty server.  By now only the
-    MAX_BODY_SIZE will be delivered to you, as no more info is
+    This interface provides important information for uploading and
+    downloading files to your Bepasty server. For now, only
+    MAX_BODY_SIZE is provided, as no more information is
     available.
 
     MAX_BODY_SIZE
-        The maximum size of a post request's body. This is limited by
-        the webserver and other middleware. See the documentation for
+        The maximum size of a POST request body. This is limited by
+        the web server and other middleware. See the documentation for
         more information. This also gives you the maximum size for the
         chunked upload.
 
     MAX_ALLOWED_FILE_SIZE
-        The maximum allowed filesize that can be stored on the
-        server. Files uploads bigger than this limit will be aborted
+        The maximum allowed file size that can be stored on the
+        server. File uploads bigger than this limit will be aborted
         and the file on the server will be deleted.
 
 Uploading a file
@@ -82,41 +82,41 @@ API Interface:
 
     When uploading a file, chunked upload is mandatory. Check the
     MAX_BODY_SIZE for the maximum chunk size that can be sent to the
-    server. The body of the post request contains the base64 encoded
+    server. The body of the POST request contains the Base64-encoded
     binary of the file to be uploaded. (required permission:
     :ref:`create <permissions>`)
 
 POST Request by the client:
 
     Post Request Body
-        Contains the base64 encoded binary of the file to be uploaded.
+        Contains the Base64-encoded binary of the file to be uploaded.
 
     The following headers *can (cursive)* or **must (bold)** be
-    delivered by every post request to the server:
+    delivered by every POST request to the server:
 
     **Content-Range**
-        The content-range header follows the specification by the w3c
+        The Content-Range header follows the specification by the W3C
         (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16).
-        It has to be provided consistently and can resume a aborted
-        file upload, together with the transaction-ID.
+        It must be provided consistently and can resume an aborted
+        file upload, together with the Transaction-ID.
 
     **Transaction-ID**
-        The transaction-ID will be provided by the server after the
-        first upload chunk. After that first chunk, the transaction-id
-        has to be provided by the client, to continue uploading the
+        The Transaction-ID will be provided by the server after the
+        first upload chunk. After that first chunk, the Transaction-ID
+        has to be provided by the client to continue uploading the
         file.
 
     *Content-Type*
-        The content-type of the file uploaded to the server. If the
-        content-type is not given, the server will guess the
-        content-type by the filename. If this fails the content-type
-        will be 'application/octet-stream'
+        The content type of the file uploaded to the server. If the
+        content type is not given, the server will guess the
+        content type by the filename. If this fails, the content type
+        will be 'application/octet-stream'.
 
     *Content-Length*
-        The content-length is mostly ignored by the server. It can be
+        The Content-Length is mostly ignored by the server. It can be
         used to indicate the final file size. If your final file size
         is bigger than the maximum allowed size on the server, the
-        upload will be aborted. The real filesize will be calculated
+        upload will be aborted. The real file size will be calculated
         by the server while uploading.
 
     *Content-Filename*
@@ -199,9 +199,9 @@ GET Response by the server:
         *Locked*
             Whether the file is locked or not.
         *Hash*
-            The sha256 hash of the file uploaded. Calculated by the server.
+            The SHA256 hash of the file uploaded. Calculated by the server.
         *Type*
-            Mimetype of the file uploaded. If no filetype is provided
+            MIME type of the file uploaded. If no file type is provided
             this will be set to 'application/octet-stream'.
 
 Retrieving Item List
@@ -349,7 +349,7 @@ API Interface:
 
         POST /apis/rest/items/<itemname>/unlock
 
-    Lock a file specified by ``<itemname>``. (required permission:
+    Unlock a file specified by ``<itemname>``. (required permission:
     :ref:`admin <permissions>`)
 
 POST Request by the client: