From 4f44d7a2063c8dfdffe9d19f2d5bb6979c718bd1 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Fri, 7 Aug 2020 19:30:37 -0500 Subject: Remove docs/ and update readme with more info --- docs/source/getting-started.rst | 141 ---------------------------------------- 1 file changed, 141 deletions(-) delete mode 100644 docs/source/getting-started.rst (limited to 'docs/source/getting-started.rst') diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst deleted file mode 100644 index 92264a3..0000000 --- a/docs/source/getting-started.rst +++ /dev/null @@ -1,141 +0,0 @@ -Getting Started -=============== - -Example -------- - -The ``config_file`` package exposes ``ConfigFile``, ``ParsingError``, -and ``BaseParser`` to the public API. - -Sample Configuration File -~~~~~~~~~~~~~~~~~~~~~~~~~ - -``config.ini`` - -.. code:: ini - - [calendar] - today = monday - start_week_on_sunday = false - today_index = 0 - quarter_hours_passed = 0.25 - -Create a ConfigFile -~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - from config_file import ConfigFile - - config = ConfigFile("~/.config/test/config.ini") - -Output your config file as a string -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - config.stringify() - >>> '[calendar]\ntoday = monday\nstart_week_on_sunday = false\ntoday_index = 0\nquarter_hours_passed = 0.25\n\n' - -Retrieve values or sections -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A section.key format is used for retrieving and setting values. - -.. code:: python - - # Values from the config file are automatically parsed - config.get("calendar.start_week_on_sunday") - >>> False - - # Unless you don't want them to be parsed - config.get("calendar.start_week_on_sunday", parse_types=False) - >>> 'false' - - config.get("calendar") - >>> {'today': 'monday', 'start_week_on_sunday': False, 'today_index': 0, 'quarter_hours_passed': 0.25} - -Set values -~~~~~~~~~~ - -.. code:: python - - config.set("calendar.today_index", 20) - >>> True - config.stringify() - >>> '[calendar]\ntoday = monday\nstart_week_on_sunday = false\ntoday_index = 20\nquarter_hours_passed = 0.25\n\n' - - # If you specify a section that isn't in your config file, the section and the key are added for you. - config.set("week.tuesday_index", 2) - >>> True - config.stringify() - >>> '[calendar]\ntoday = monday\nstart_week_on_sunday = false\ntoday_index = 20\nquarter_hours_passed = 0.25\n\n[week]\ntuesday_index = 2\n\n' - -.. _delete-sections-or-keyvalue-pairs: - -Delete sections or key/value pairs. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - config.delete('week') - >>> True - config.stringify() - >>> '[calendar]\ntoday = monday\nstart_week_on_sunday = false\ntoday_index = 20\nquarter_hours_passed = 0.25\n\n' - - config.delete('calendar.today') - >>> True - config.stringify() - >>> '[calendar]\nstart_week_on_sunday = false\ntoday_index = 20\nquarter_hours_passed = 0.25\n\n' - -Check whether you have a particular section or key -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - config.has('calendar') - >>> True - - config.has('week') - >>> False - - config.has('calendar.start_week_on_sunday') - >>> True - -Save when you're done -~~~~~~~~~~~~~~~~~~~~~ - -Write the contents of the file back out. ``set()`` and ``delete()`` both -modify the contents of the file and require a call to ``save()`` to -write those changes back out. - -.. code:: python - - config.save() - >>> True - -Restore the file back to its original -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The current configuration file would be deleted and replaced by a copy -of the original. By default, since our passed in config file was at path -``~/.config/test/config.ini``, ``restore_original()`` will look for -``~/.config/test/config.original.ini``. - -.. code:: python - - config.restore_original() - >>> True - - # But you can also specify the original config file explicitly. - config.restore_original(original_file_path="~/some_other_directory/this_is_actually_the_original.ini") - >>> True - -Using your own parser ---------------------- - -You can still use config file, even if you don't use one of our supported -configuration formats. The ``ConfigFile`` object swaps in the parser it needs -based on the file format. However, the constructor takes in an optional -parser argument that you can use to supply your own custom parser. The only -requirement is that the parser must be a concrete implementation of ``BaseParser``. \ No newline at end of file -- cgit v1.2.3