release v1

cats/__init__.py

@@ -75,13 +75,14 @@ def parse_arguments():
         cats -d 90 --loc OX1 -s at -c 'mycommand'
 
     To report carbon footprint, pass the `--config` option to select a
-    configuration file and the `--profile` option to select a profile. An
+    configuration file and the `--profile` option to select a profile.
+    The configuration file is documented in the Quickstart section of the online
+    documentation. An
     example config file is given below:
 
-{config_text}
+.. code-block:: yaml
 
-    The configuration file is documented in the Quickstart section of the online
-    documentation.
+{config_text}
     """
 
     parser = ArgumentParser(
@@ -226,7 +227,7 @@ def schedule_at(
     """
     proc = subprocess.Popen(args, stdout=subprocess.PIPE)
     try:
-        proc_output = subprocess.check_output(
+        subprocess.check_output(
             (
                 at_command,
                 "-t",

docs/source/api-reference.rst

@@ -11,16 +11,10 @@ please see :ref:`cli-reference`.
 Modules
 -------
 
-``cats.__init__``
+``cats``
 ^^^^^^^^^^^^^^^^^
 
-.. automodule:: cats.__init__
-    :members:
-
-``cats.__main__``
-^^^^^^^^^^^^^^^^^
-
-.. automodule:: cats.__main__
+.. automodule:: cats
     :members:
 
 ``cats.configure``

docs/source/conf.py

@@ -26,7 +26,7 @@
 author = authors
 copyright = f"2023, {authors}"
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+release = "1.0.0"
 
 # Add media: image for logo and a favicon for the browser tab
 html_logo = "_static/cats_dalle_img_200x200px_for_logo.png"

docs/source/quickstart.rst

@@ -76,7 +76,7 @@ quantity of hardware the job using. This information is provided by
 adding a section ``profiles`` to the :ref:`cats YAML configuration
 file <configuration-file>`.
 
-You can define an arbitraty number of profiles as subsection of the
+You can define an arbitrary number of profiles as subsection of the
 top-level ``profiles`` section:
 
 .. literalinclude :: ../../cats/config.yml
@@ -106,6 +106,6 @@ at the command line:
         --profile my_gpu_profile --gpu 4 --cpu 1
 
 .. warning::
-   The ``--profile`` option is optional. Is not provided, ``cats`` uses the
+   The ``--profile`` option is optional. If not provided, ``cats`` uses the
    first profile defined in the configuration file as the default
    profile.

pyproject.toml

@@ -8,7 +8,7 @@
 
 [project]
   name = "climate-aware-task-scheduler"
-  version = "1.0rc1"
+  version = "1.0.0"
   description = "Climate aware task scheduler"
   authors = [
     { name = "Colin Sauze" },
@@ -25,7 +25,14 @@
   license = { file = "LICENSE" }
   requires-python = ">=3.9"
   readme = "README.md"
-  classifiers = ["License :: OSI Approved :: MIT License"]
+  classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: System Administrators",
+  ]
   dependencies = ["requests-cache>=1.0", "PyYAML>=6.0"]
 
   [project.optional-dependencies]