acheived higher coverage for components fixed typos

Author: Saksham-Sirohi

app/eventyay/eventyay_common/tasks.py

@@ -168,20 +168,18 @@ def collect_billing_invoice(
     invoice_voucher: Optional[InvoiceVoucher],
 ) -> CollectBillingResponse:
     """
-    Collect billing data for an event on a monthly basis. This function
-    checks if a billing invoice already exists for the given event and
+    Collect billing data for an event on a monthly basis.
+    
+    This function checks if a billing invoice already exists for the given event and
     month. If not, it checks if there were any paid orders in the last
     month, and if there were, it calculates the total amount and ticket
     fee for the last month and creates a new billing invoice.
 
-    @param event: The event for which to collect billing data.
-    @param last_month_date: The date of the last month for which to collect
-        billing data.
-    @param ticket_rate: The rate of the ticket fee as a decimal.
-    @param invoice_voucher: The voucher for which to calculate the ticket fee
-        discount.
-
-    @return: A CollectBillingResponse object containing a boolean value
+    :param event: The event for which to collect billing data.
+    :param last_month_date: The date of the last month for which to collect billing data.
+    :param ticket_rate: The rate of the ticket fee as a decimal.
+    :param invoice_voucher: The voucher for which to calculate the ticket fee discount.
+    :return: A CollectBillingResponse object containing a boolean value
         indicating whether the billing invoice was created successfully and a
         decimal value indicating the voucher discount.
     """

doc/admin/config.rst

@@ -11,9 +11,9 @@ the following order. The file that is found *last* will override the settings fr
 the files found before.
 
 1. ``PRETIX_CONFIG_FILE`` environment variable
-2. ``/etc/eventyay/Eventyay.cfg``
+2. ``/etc/eventyay/eventyay.cfg``
 3. ``~/.Eventyay.cfg``
-4. ``Eventyay.cfg`` in the current working directory
+4. ``eventyay.cfg`` in the current working directory
 
 The file is expected to be in the INI format as specified in the `Python documentation`_.
 
@@ -23,7 +23,7 @@ installation tutorials.
 
 .. note::
 
-    The configuration file is the recommended way to configure Eventyay. However, you can
+    The configuration file is the recommended way to configure eventyay. However, you can
     also set them through environment variables. In this case, the syntax is
     ``PRETIX_SECTION_CONFIG``. For example, to configure the setting ``password_reset``
     from the ``[Eventyay]`` section, set ``PRETIX_PRETIX_PASSWORD_RESET=off`` in your
@@ -64,7 +64,7 @@ Example::
     Defaults to an empty string.
 
 ``auth_backends``
-    A comma-separated list of available auth backends. Defaults to ``Eventyay.base.auth.NativeAuthBackend``.
+    A comma-separated list of available auth backends. Defaults to ``eventyay.base.auth.NativeAuthBackend``.
 
 ``cookie_domain``
     The cookie domain to be set. Defaults to ``None``.
@@ -79,7 +79,7 @@ Example::
     Enables or disables the "keep me logged in" button. Defaults to ``on``.
 
 ``ecb_rates``
-    By default, Eventyay periodically downloads a XML file from the European Central Bank to retrieve exchange rates
+    By default, eventyay periodically downloads a XML file from the European Central Bank to retrieve exchange rates
     that are used to print tax amounts in the customer currency on invoices for some currencies. Set to ``off`` to
     disable this feature. Defaults to ``on``.
 
@@ -88,7 +88,7 @@ Example::
     Defaults to ``off``.
 
 ``obligatory_2fa``
-    Enables or disables obligatory usage of Two-Factor Authentication for users of the Eventyay backend.
+    Enables or disables obligatory usage of Two-Factor Authentication for users of the eventyay backend.
     Defaults to ``False``
 
 ``trust_x_forwarded_for``
@@ -105,8 +105,8 @@ Example::
     Log violations of the Content Security Policy (CSP). Defaults to ``on``.
 
 ``csp_additional_header``
-    Specifies a CSP header that will be **merged** with Eventyay's default header. For example, if you set this
-    to ``script-src https://mycdn.com``, Eventyay will add ``https://mycdn.com`` as an **additional** allowed source
+    Specifies a CSP header that will be **merged** with eventyay's default header. For example, if you set this
+    to ``script-src https://mycdn.com``, eventyay will add ``https://mycdn.com`` as an **additional** allowed source
     to all CSP headers. Empty by default.
 
 ``loglevel``
@@ -134,8 +134,8 @@ Example::
 
     [database]
     backend=postgresql
-    name=Eventyay
-    user=Eventyay
+    name=eventyay
+    user=eventyay
     password=abcd
     host=localhost
     port=3306
@@ -156,11 +156,11 @@ Example::
 Database replica settings
 -------------------------
 
-If you use a replicated database setup, Eventyay expects that the default database connection always points to the primary database node.
+If you use a replicated database setup, eventyay expects that the default database connection always points to the primary database node.
 Routing read queries to a replica on database layer is **strongly** discouraged since this can lead to inaccurate such as more tickets
 being sold than are actually available.
 
-However, Eventyay can still make use of a database replica to keep some expensive queries with that can tolerate some latency from your
+However, eventyay can still make use of a database replica to keep some expensive queries with that can tolerate some latency from your
 primary database, such as backend search queries. The ``replica`` configuration section can have the same settings as the ``database``
 section (except for the ``backend`` setting) and will default back to the ``database`` settings for all values that are not given. This
 way, you just need to specify the settings that are different for the replica.
@@ -199,7 +199,7 @@ Example::
     [mail]
     from=hello@localhost
     host=127.0.0.71
-    user=Eventyay
+    user=eventyay
     password=foobar
     port=1025
     tls=on
@@ -213,13 +213,13 @@ Example::
 
 ``from``
     The email address to set as ``From`` header in outgoing emails by the system.
-    Default: ``Eventyay@localhost``
+    Default: ``eventyay@localhost``
 
 ``tls``, ``ssl``
     Use STARTTLS or SSL for the SMTP connection. Off by default.
 
 ``admins``
-    Comma-separated list of email addresses that should receive a report about every error code 500 thrown by Eventyay.
+    Comma-separated list of email addresses that should receive a report about every error code 500 thrown by eventyay.
 
 .. _`django-settings`:
 
@@ -234,7 +234,7 @@ Example::
 
 ``secret``
     The secret to be used by Django for signing and verification purposes. If this
-    setting is not provided, Eventyay will generate a random secret on the first start
+    setting is not provided, eventyay will generate a random secret on the first start
     and will store it in the filesystem for later usage.
 
 ``debug``
@@ -265,24 +265,24 @@ Currently, metrics-collection requires a redis server to be available.
 Memcached
 ---------
 
-You can use an existing memcached server as Eventyay's caching backend::
+You can use an existing memcached server as eventyay's caching backend::
 
     [memcached]
     location=127.0.0.1:11211
 
 ``location``
     The location of memcached, either a host:port combination or a socket file.
 
-If no memcached is configured, Eventyay will use Django's built-in local-memory caching method.
+If no memcached is configured, eventyay will use Django's built-in local-memory caching method.
 
-.. note:: If you use memcached and you deploy Eventyay across multiple servers, you should use *one*
+.. note:: If you use memcached and you deploy eventyay across multiple servers, you should use *one*
           shared memcached instance, not multiple ones, because cache invalidations would not be
           propagated otherwise.
 
 Redis
 -----
 
-If a redis server is configured, Eventyay can use it for locking, caching and session storage
+If a redis server is configured, eventyay can use it for locking, caching and session storage
 to speed up various operations::
 
     [redis]
@@ -296,7 +296,7 @@ to speed up various operations::
 ``session``
     When this is set to ``True``, redis will be used as the session storage.
 
-If redis is not configured, Eventyay will store sessions and locks in the database. If memcached
+If redis is not configured, eventyay will store sessions and locks in the database. If memcached
 is configured, memcached will be used for caching instead of redis.
 
 Translations
@@ -309,18 +309,18 @@ can activate them like this::
     [languages]
     allow_incubating=pt-br,da
 
-You can also tell Eventyay about additional paths where it will search for translations::
+You can also tell eventyay about additional paths where it will search for translations::
 
     [languages]
     path=/path/to/my/translations
 
-For a given language (e.g. ``pt-br``), Eventyay will then look in the
+For a given language (e.g. ``pt-br``), eventyay will then look in the
 specific sub-folder, e.g. ``/path/to/my/translations/pt_BR/LC_MESSAGES/django.po``.
 
 Celery task queue
 -----------------
 
-For processing long-running tasks asynchronously, Eventyay requires the celery task queue.
+For processing long-running tasks asynchronously, eventyay requires the celery task queue.
 For communication between the web server and the task workers in both direction, a messaging
 queue and a result backend is needed. You can use a redis database for both directions, or
 an AMQP server (e.g. RabbitMQ) as a broker and redis or your database as a result backend::
@@ -349,7 +349,7 @@ application. If you want to use sentry, you need to set a DSN in the configurati
 Caching
 -------
 
-You can adjust some caching settings to control how much storage Eventyay uses::
+You can adjust some caching settings to control how much storage eventyay uses::
 
     [cache]
     tickets=48  ; Number of hours tickets (PDF, passbook, …) are cached
@@ -358,7 +358,7 @@ You can adjust some caching settings to control how much storage Eventyay uses::
 Secret length
 -------------
 
-If you are really paranoid, you can increase the length of random strings Eventyay uses in
+If you are really paranoid, you can increase the length of random strings eventyay uses in
 various places like order codes, secrets in the ticket QR codes, etc. Example::
 
     [entropy]

doc/admin/index.rst

@@ -3,7 +3,7 @@
 Administrator documentation
 ===========================
 
-This documentation is for everyone who wants to install Eventyay on a server.
+This documentation is for everyone who wants to install eventyay on a server.
 
 .. toctree::
    :maxdepth: 2

doc/admin/indexes.rst

@@ -1,16 +1,16 @@
 Additional database indices
 ===========================
 
-If you have a large Eventyay database, some features such as search for orders or events might turn pretty slow.
+If you have a large eventyay database, some features such as search for orders or events might turn pretty slow.
 For PostgreSQL, we have compiled a list of additional database indexes that you can add to speed things up.
 Just like any index, they in turn make write operations insignificantly slower and cause the database to use
 more disk space.
 
-The indexes aren't automatically created by Eventyay since Django does not allow us to do so only on PostgreSQL
+The indexes aren't automatically created by eventyay since Django does not allow us to do so only on PostgreSQL
 (and they won't work on other databases). Also, they're really not necessary if you're not having tens of
 thousands of records in your database.
 
-However, this also means they won't automatically adapt if some of the referred fields change in future updates of Eventyay
+However, this also means they won't automatically adapt if some of the referred fields change in future updates of eventyay
 and you might need to re-check this page and change them manually.
 
 Here is the currently recommended set of commands::
@@ -66,7 +66,7 @@ Here is the currently recommended set of commands::
         ON public.eventyaybase_voucher (upper((code)::text));
 
 
-Also, if you use our ``Eventyay-shipping`` plugin::
+Also, if you use our ``eventyay-shipping`` plugin::
 
     CREATE INDEX CONCURRENTLY eventyay_addidx_sa_name
         ON eventyay_shipping_shippingaddress

doc/admin/installation/dev_version.rst

@@ -3,8 +3,8 @@
 Installing a development version
 ================================
 
-If you want to use a feature of Eventyay that is not yet contained in the last monthly release, you can also
-install a development version with Eventyay.
+If you want to use a feature of eventyay that is not yet contained in the last monthly release, you can also
+install a development version with eventyay.
 
 .. warning:: When in production, we strongly recommend only installing released versions. Development versions might
              be broken, incompatible to plugins, or in rare cases incompatible to upgrade later on.
@@ -13,14 +13,14 @@ install a development version with Eventyay.
 Manual installation
 -------------------
 
-You can use ``pip`` to update Eventyay directly to the development branch. Then, upgrade as usual::
+You can use ``pip`` to update eventyay directly to the development branch. Then, upgrade as usual::
 
     $ source /var/eventyay/venv/bin/activate
-    (venv)$ pip3 install -U "git+https://github.com/fossasia/eventyay.git#egg=Eventyay&subdirectory=src"
-    (venv)$ python -m Eventyay migrate
-    (venv)$ python -m Eventyay rebuild
-    (venv)$ python -m Eventyay updatestyles
-    # systemctl restart Eventyay-web Eventyay-worker
+    (venv)$ pip3 install -U "git+https://github.com/fossasia/eventyay.git#egg=eventyay&subdirectory=src"
+    (venv)$ python -m eventyay migrate
+    (venv)$ python -m eventyay rebuild
+    (venv)$ python -m eventyay updatestyles
+    # systemctl restart eventyay-web eventyay-worker
 
 Docker installation
 -------------------
@@ -30,8 +30,8 @@ To use the latest development version with Docker, first pull it from Docker Hub
     $ docker pull fossasia/eventyay-tickets:latest
 
 
-Then change your ``/etc/systemd/system/Eventyay.service`` file to use the ``:latest`` tag instead of ``:stable`` as well
+Then change your ``/etc/systemd/system/eventyay.service`` file to use the ``:latest`` tag instead of ``:stable`` as well
 and upgrade as usual::
 
-    $ systemctl restart Eventyay.service
-    $ docker exec -it Eventyay.service Eventyay upgrade
+    $ systemctl restart eventyay.service
+    $ docker exec -it eventyay.service eventyay upgrade