0.0.5 release

Author: s-m-e

.travis.yml

@@ -32,14 +32,14 @@ language: python
 # Ubuntu & Python versions
 matrix:
     include:
-        - dist: trusty
-          python: "3.4"
         - dist: xenial
           python: "3.5"
         - dist: xenial
           python: "3.6"
         - dist: xenial
           python: "3.7"
+        - dist: xenial
+          python: "3.8"
 
 # Install dependencies
 addons:

CHANGES.rst

@@ -1,6 +1,13 @@
 Changes
 =======
 
+0.0.6 (2020-07-11)
+------------------
+
+* FEATURE: Added Python 3.8 support
+* Dropped Python 3.4 support
+* Updated dependency to ``refuse`` 0.0.4
+
 0.0.5 (2019-05-06)
 ------------------
 

CONTRIBUTING.rst

@@ -26,20 +26,13 @@ Issues are tracked on `Gitbub`_.
 Submitting patches
 ------------------
 
-- Run ``make test`` before submission and attach the resulting
-  ``tests/test_status_diff.yaml`` file to your pull request (indicating which
-  tests the file-system now passes that did worked before).
+- Run ``make test`` before submission and indicate which tests the file-system now passes that did worked before.
 - Use **tabs** for indentation.
 - No, there is no line limit. Let your editor wrap the lines for you, if you want.
 - Add as many comments as you can - code-readability matters.
-- The ``master`` branch is supposed to be stable - request merges into the
-  ``develop`` branch instead.
+- The ``master`` branch is supposed to be stable - request merges into the ``develop`` branch instead.
 - Commits are preferred to be signed (GPG). Seriously, sign your code.
 
-Looking for work? Check `tests flagged as false`_. There are plenty of them.
-
-.. _tests flagged as false: https://github.com/pleiszenburg/loggedfs-python/blob/develop/tests/test_status_frozen.yaml
-
 First time setup
 ----------------
 

README.rst

@@ -76,10 +76,10 @@ From GitHub:
 
 	pip install git+https://github.com/pleiszenburg/loggedfs-python.git@master
 
-**Supports Python 3.{4,5,6,7}.**
+**Supports Python 3.{5,6,7,8}.**
 
 **Supports Linux.**
-Support for MAC OS X is implemented but has yet not been tested.
+Support for MAC OS X and BSD is implemented but has yet not been tested.
 
 .. _Python Package Index: https://pypi.org/
 
@@ -100,6 +100,37 @@ To stop recording, just unmount as usual:
 	sudo fusermount -u /tmp/TEST
 
 
+CLI usage
+=========
+
+.. code:: bash
+
+	loggedfs --help
+	Usage: loggedfs [OPTIONS] DIRECTORY
+
+	Options:
+	  -f                            Do not start as a daemon. Write logs to stdout
+	                                if no log file is specified.
+
+	  -p                            Allow every user to see the new loggedfs.
+	  -c FILENAME                   Use the "config-file" to filter what you want
+	                                to log.
+
+	  -s                            Deactivate logging to syslog.
+	  -l FILE                       Use the "log-file" to write logs to.
+	  -j, --json                    Format output as JSON instead of traditional
+	                                loggedfs format.
+
+	  -b, --buffers                 Include read/write-buffers (compressed,
+	                                BASE64) in log.
+
+	  -m, --only-modify-operations  Exclude logging of all operations that can not
+	                                cause changes in the filesystem. Convenience
+	                                flag for accelerated logging.
+
+	  --help                        Show this message and exit.
+
+
 Configuration
 =============
 
@@ -143,24 +174,17 @@ Please report bugs in LoggedFS-python here in its `GitHub issue tracker`_.
 Miscellaneous
 =============
 
-- Full project documentation
-
-  - at `Read the Docs`_
-  - at `LoggedFS-python repository`_
-
+- Library documentation: `LoggedFS-python Jupyter Notebook`_
 - `License`_ (**Apache License 2.0**)
 - `Contributing`_ (**Contributions are highly welcomed!**)
-- `FAQ`_
 - `Authors`_
 - `Changes`_
 - `Long-term ideas`_
 - `Upstream issues`_ (relevant bugs in dependencies)
 
-.. _Read the Docs: http://loggedfs-python.readthedocs.io/en/latest/
-.. _LoggedFS-python repository: https://github.com/pleiszenburg/loggedfs-python/blob/master/docs/index.rst
+.. _LoggedFS-python Jupyter Notebook: https://github.com/pleiszenburg/loggedfs-python/blob/master/docs/library_demo.ipynb
 .. _License: https://github.com/pleiszenburg/loggedfs-python/blob/master/LICENSE
 .. _Contributing: https://github.com/pleiszenburg/loggedfs-python/blob/master/CONTRIBUTING.rst
-.. _FAQ: http://loggedfs-python.readthedocs.io/en/stable/faq.html
 .. _Authors: https://github.com/pleiszenburg/loggedfs-python/blob/master/AUTHORS.rst
 .. _Changes: https://github.com/pleiszenburg/loggedfs-python/blob/master/CHANGES.rst
 .. _Long-term ideas: https://github.com/pleiszenburg/loggedfs-python/milestone/2

makefile

@@ -4,7 +4,7 @@
 #
 #	makefile: GNU makefile for project management
 #
-# 	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+# 	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 #
 # <LICENSE_BLOCK>
 # The contents of this file are subject to the Apache License

setup.py

@@ -8,7 +8,7 @@
 
 	setup.py: Used for package distribution
 
-	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License
@@ -43,14 +43,16 @@
 
 
 # Bump version HERE!
-_version_ = '0.0.5'
+_version_ = '0.0.6'
 
 
 # List all versions of Python which are supported
+python_minor_min = 5
+python_minor_max = 8
 confirmed_python_versions = [
-	('Programming Language :: Python :: %s' % x)
-	for x in '3.4 3.5 3.6 3.7'.split(' ')
-	]
+    'Programming Language :: Python :: 3.{MINOR:d}'.format(MINOR = minor)
+    for minor in range(python_minor_min, python_minor_max + 1)
+    ]
 
 
 # Fetch readme file
@@ -63,7 +65,7 @@
 	'coverage',
 	'psutil',
 	'pytest',
-	'python-language-server',
+	'python-language-server[all]',
 	'PyYAML',
 	'setuptools',
 	'Sphinx',
@@ -98,9 +100,10 @@
 	license = 'Apache License 2.0',
 	keywords = ['filesystem', 'fuse', 'logging', 'monitoring'],
 	include_package_data = True,
+	python_requires = '>=3.{MINOR:d}'.format(MINOR = python_minor_min),
 	install_requires = [
 		'click>=7.0',
-		'refuse==0.0.2',
+		'refuse==0.0.4',
 		'xmltodict'
 		],
 	extras_require = {'dev': development_deps_list},

src/loggedfs/__init__.py

@@ -8,7 +8,7 @@
 
 	src/loggedfs/__init__.py: Module init
 
-	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License

src/loggedfs/_core/__init__.py

@@ -8,7 +8,7 @@
 
 	src/loggedfs/_core/__init__.py: Module core init
 
-	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License

src/loggedfs/_core/cli.py

@@ -8,7 +8,7 @@
 
 	src/loggedfs/_core/cli.py: Command line interface
 
-	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License

src/loggedfs/_core/defaults.py

@@ -8,7 +8,7 @@
 
 	src/loggedfs/_core/defaults.py: Default configurations
 
-	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2020 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License