prepared for initial release

Author: s-m-e

.travis.yml

@@ -26,18 +26,20 @@
 # https://github.com/travis-ci/travis-ci/issues/1100#issuecomment-160169121
 sudo: required
 
-# Go for more 'recent' version of Ubuntu
-dist: trusty
-
 # Repository language
 language: python
 
-# Python version
-python:
-  - "3.4"
-  - "3.5"
-  - "3.6"
-  # - "3.7-dev"
+# 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"
 
 # Install dependencies
 addons:
@@ -54,6 +56,8 @@ before_install:
   - sudo chown root:$USER /etc/fuse.conf
   - sudo echo "user_allow_other" | sudo tee -a /etc/fuse.conf > /dev/null
   - python --version
+  - pip install -U pip
+  - pip install -U setuptools
   - uname -a
 
 # command to install dependencies and module

README.rst

@@ -6,11 +6,27 @@
 	:target: https://travis-ci.org/pleiszenburg/loggedfs-python
 	:alt: Build Status: development branch
 
+.. |license| image:: https://img.shields.io/pypi/l/loggedfs.svg?style=flat-square
+	:target: https://github.com/pleiszenburg/loggedfs/blob/master/LICENSE
+	:alt: Project License: Apache License v2
+
+.. |status| image:: https://img.shields.io/pypi/status/loggedfs.svg?style=flat-square
+	:target: https://github.com/pleiszenburg/loggedfs-python/milestone/1
+	:alt: Project Development Status
+
+.. |pypi_version| image:: https://img.shields.io/pypi/v/loggedfs.svg?style=flat-square
+	:target: https://pypi.python.org/pypi/loggedfs
+	:alt: Available on PyPi - the Python Package Index
+
+.. |pypi_versions| image:: https://img.shields.io/pypi/pyversions/loggedfs.svg?style=flat-square
+	:target: https://pypi.python.org/pypi/loggedfs
+	:alt: Available on PyPi - the Python Package Index
+
 .. |loggedfs_python_logo| image:: http://www.pleiszenburg.de/loggedfs-python_logo.png
 	:target: https://github.com/pleiszenburg/loggedfs-python
 	:alt: LoggedFS-python repository
 
-|build_master| |build_develop|
+|build_master| |build_develop| |license| |status| |pypi_version| |pypi_versions|
 
 |loggedfs_python_logo|
 
@@ -21,8 +37,9 @@ LoggedFS-python is a FUSE-based filesystem which can log every operation that ha
 It is a pure Python re-implementation of `LoggedFS`_ by `Rémi Flament`_ maintaining CLI compatibility.
 The project is heavily inspired by `Stavros Korokithakis`_' 2013 blog post entitled
 "`Writing a FUSE filesystem in Python`_" (`source code repository`_).
-The filesystem is fully `POSIX`_ compliant (passing the `pjdfstest test-suite`_)
-and intended to be suitable for production systems (it is not yet!).
+The filesystem is fully `POSIX`_ compliant, passing the `pjdfstest test-suite`_, a descendant of FreeBSD's `fstest`_.
+It furthermore passes stress tests with fsx-linux based on the `fsx-flavor`_  released by the `Linux Test Project`_.
+It is intended to be suitable for production systems.
 
 .. _LoggedFS: https://github.com/rflament/loggedfs
 .. _Rémi Flament: https://github.com/rflament
@@ -31,47 +48,49 @@ and intended to be suitable for production systems (it is not yet!).
 .. _source code repository: https://github.com/skorokithakis/python-fuse-sample
 .. _POSIX: https://en.wikipedia.org/wiki/POSIX
 .. _pjdfstest test-suite: https://github.com/pjd/pjdfstest
+.. _fstest: https://github.com/zfsonlinux/fstest
+.. _fsx-flavor: http://codemonkey.org.uk/projects/fsx/
+.. _Linux Test Project: https://github.com/linux-test-project/ltp
 
 
 CAVEATS
 =======
 
 * PROJECT STATUS: **BETA**
-* THE FILESYSTEM HAS RECEIVED **SOME STRESS TESTS WITH FSX-LINUX**
-  BASED ON THE `FSX-FLAVOR`_ RELEASED BY THE `LINUX TEST PROJECT`_.
-  **FSX REPORTS WRITE HOLES!**
-  FULL TESTS UND RELATED BUG-FIXES ARE UNDER WAY.
 * A `CUSTOM BUG-FIXED VERSION OF FUSEPY`_ IS REQUIRED FOR FULL POSIX COMPLIANCE.
+  IT IS AUTOMATICALLY INSTALLED FROM GITHUB AS A DEPENDENCY OF THIS PACKAGE.
   IF THE LATEST OFFICIAL RELEASE OF FUSEPY IS USED INSTEAD, TIMESTAMPS WILL BE
   INACCURATE ON A NANOSECOND TO MICROSECOND SCALE AND UTIME_NOW AS WELL AS
-  UTIME_OMIT WILL NOT BE HONORED. THERE IS A `PENDING PULL REQUEST`_.
+  UTIME_OMIT WILL NOT BE HONORED. THERE WAS A `PULL REQUEST`_ TO FIX THIS,
+  WHICH HAS BEEN REJECTED. ALTERNATIVE APPROACHES ARE BEING RESEARCHED.
 * THE FILESYSTEM IS CURRENTLY **ONLY** BEING DEVELOPED FOR AND TESTED ON **LINUX**.
   ANYONE INTERESTED IN ADDING MAC OS X AND/OR BSD SUPPORT?
 
-.. _FSX-FLAVOR: http://codemonkey.org.uk/projects/fsx/
-.. _LINUX TEST PROJECT: https://github.com/linux-test-project/ltp
 .. _CUSTOM BUG-FIXED VERSION OF FUSEPY: https://github.com/s-m-e/fusepy
-.. _PENDING PULL REQUEST: https://github.com/fusepy/fusepy/pull/79
+.. _PULL REQUEST: https://github.com/fusepy/fusepy/pull/79
 
 
 Installation
 ============
 
+From the `Python Package Index`_ (PyPI):
+
 .. code:: bash
 
-	pip install git+https://github.com/pleiszenburg/loggedfs-python.git@master
+	pip install loggedfs
+
+From GitHub:
 
-This project has intentionally not yet been published in the `Python Package Index`_ (PyPI).
-It will be released on PyPI once critical changes have been merged into `fusepy`_,
-a dependency of LoggedFS-python.
+.. code:: bash
+
+	pip install git+https://github.com/pleiszenburg/loggedfs-python.git@master
 
-**Supports Python 3.{4,5,6}.**
+**Supports Python 3.{4,5,6,7}.**
 
 **Supports Linux.**
-Support for MAC OS X and BSD likely requires minor changes only, but has yet not been added.
+Support for MAC OS X and BSD requires a minor change only, but has yet not been added: Access to the system log is currently being achieved through ``logging.handlers.SysLogHandler(address = '/dev/log')``, a Linux-only solution.
 
 .. _Python Package Index: https://pypi.org/
-.. _fusepy: https://github.com/fusepy/fusepy
 
 
 Simple usage example

makefile

@@ -4,7 +4,7 @@
 #
 #	makefile: GNU makefile for project management
 #
-# 	Copyright (C) 2017-2018 Sebastian M. Ernst <[email protected]>
+# 	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
 #
 # <LICENSE_BLOCK>
 # The contents of this file are subject to the Apache License
@@ -21,15 +21,29 @@
 
 T = ""
 
+clean:
+	-rm -r build/*
+	-rm -r dist/*
+	-rm -r src/*.egg-info
+	# -rm -r htmlconv/*
+	# -rm .coverage*
+	coverage erase
+	find src/ tests/ -name '*.pyc' -exec rm -f {} +
+	find src/ tests/ -name '*.pyo' -exec rm -f {} +
+	# find src/ tests/ -name '*~' -exec rm -f {} +
+	find src/ tests/ -name '__pycache__' -exec rm -fr {} +
+	# find src/ tests/ -name '*.htm' -exec rm -f {} +
+	# find src/ tests/ -name '*.html' -exec rm -f {} +
+	# find src/ tests/ -name '*.so' -exec rm -f {} +
+
 # docu:
 # 	@(cd docs; make clean; make html)
 
 release:
-	-rm dist/*
-	-rm -r src/*.egg-info
+	make clean
 	python setup.py sdist bdist_wheel
-	gpg --detach-sign -a dist/literatur*.whl
-	gpg --detach-sign -a dist/literatur*.tar.gz
+	gpg --detach-sign -a dist/loggedfs*.whl
+	gpg --detach-sign -a dist/loggedfs*.tar.gz
 
 upload:
 	for filename in $$(ls dist/*.tar.gz dist/*.whl) ; do \
@@ -42,12 +56,12 @@ upload_test:
 	done
 
 install:
-	pip install --process-dependency-links .[dev]
+	pip install .[dev]
 	make install_fstest
 	make install_fsx
 
 install_link:
-	pip install --process-dependency-links -e .[dev]
+	pip install -e .[dev]
 	make install_fstest
 	make install_fsx
 

requirements.txt

@@ -8,7 +8,7 @@
 
 	setup.py: Used for package distribution
 
-	Copyright (C) 2017-2018 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License
@@ -43,13 +43,13 @@
 
 
 # Bump version HERE!
-_version_ = '0.0.0'
+_version_ = '0.0.1'
 
 
 # List all versions of Python which are supported
 confirmed_python_versions = [
 	('Programming Language :: Python :: %s' % x)
-	for x in '3.4 3.5 3.6'.split(' ')
+	for x in '3.4 3.5 3.6 3.7'.split(' ')
 	]
 
 
@@ -98,12 +98,9 @@
 	license = 'Apache License 2.0',
 	keywords = ['filesystem', 'fuse', 'logging', 'monitoring'],
 	include_package_data = True,
-	dependency_links = [
-		'https://github.com/s-m-e/fusepy/tarball/master#egg=fusepy-2.0.99'
-		],
 	install_requires = [
 		'click',
-		'fusepy==2.0.99',
+		'fusepy @ git+https://github.com/s-m-e/fusepy@master#egg=fusepy-2.0.99',
 		'xmltodict'
 		],
 	extras_require = {'dev': development_deps_list},
@@ -113,7 +110,7 @@
 		''',
 	zip_safe = False,
 	classifiers = [
-		'Development Status :: 3 - Alpha',
+		'Development Status :: 4 - Beta',
 		'Environment :: Console',
 		'Intended Audience :: Developers',
 		'Intended Audience :: Information Technology',

setup.py

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

src/loggedfs/__init__.py

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

src/loggedfs/cli.py

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

src/loggedfs/core.py

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

tests/__init__.py

@@ -8,7 +8,7 @@
 
 	tests/conftest.py: Configures the tests
 
-	Copyright (C) 2017-2018 Sebastian M. Ernst <[email protected]>
+	Copyright (C) 2017-2019 Sebastian M. Ernst <[email protected]>
 
 <LICENSE_BLOCK>
 The contents of this file are subject to the Apache License