Merge pull request #448 from PyFilesystem/setup-actions

Replace Travis-CI with GitHub Actions

Author: althonos

.github/workflows/test.yml

@@ -0,0 +1,72 @@
+name: Test
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - 2.7
+          - 3.5
+          - 3.6
+          - 3.7
+          - 3.8
+          - 3.9
+          - pypy-2.7
+          - pypy-3.6
+          - pypy-3.7
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v1
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Update pip
+      run: python -m pip install -U pip wheel setuptools
+    - name: Install tox
+      run: python -m pip install tox tox-gh-actions
+    - name: Test with tox
+      run: python -m tox
+    - name: Collect coverage results
+      uses: AndreMiras/coveralls-python-action@develop
+      with:
+        parallel: true
+        flag-name: test (${{ matrix.python-version}})
+
+  coveralls:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Upload coverage statistics to Coveralls
+      uses: AndreMiras/coveralls-python-action@develop
+      with:
+        parallel-finished: true
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        linter:
+          - typecheck
+          - codestyle
+          - docstyle
+          - codeformat
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v1
+    - name: Setup Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - name: Update pip
+      run: python -m pip install -U pip wheel setuptools
+    - name: Install tox
+      run: python -m pip install tox tox-gh-actions
+    - name: Run ${{ matrix.linter }} linter
+      run: python -m tox -e ${{ matrix.linter }}

.travis.yml

@@ -9,8 +9,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 
 ### Changed
-- Make `FS.upload` explicit about the expected error when the parent directory of the destination does not exist
-  [#445](https://github.com/PyFilesystem/pyfilesystem2/pull/445).
+
+- Make `FS.upload` explicit about the expected error when the parent directory of the destination does not exist.
+  Closes [#445](https://github.com/PyFilesystem/pyfilesystem2/pull/445).
+- Migrate continuous integration from Travis-CI to GitHub Actions and introduce several linters
+  again in the build steps ([#448](https://github.com/PyFilesystem/pyfilesystem2/pull/448)).
+  Closes [#446](https://github.com/PyFilesystem/pyfilesystem2/pull/446).
+- Stop requiring `pytest` to run tests, allowing any test runner supporting `unittest`-style
+  test suites.
+- `FSTestCases` now builds the large data required for `upload` and `download` tests only
+  once in order to reduce the total testing time.
+
+### Fixed
+
+- Make `FTPFile`, `MemoryFile` and `RawWrapper` accept [`array.array`](https://docs.python.org/3/library/array.html)
+  arguments for the `write` and `writelines` methods, as expected by their base class [`io.RawIOBase`](https://docs.python.org/3/library/io.html#io.RawIOBase).
+- Various documentation issues, including `MemoryFS` docstring not rendering properly.
 
 
 ## [2.4.12] - 2021-01-14
@@ -22,6 +36,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   [#380](https://github.com/PyFilesystem/pyfilesystem2/issues/380).
 - Added compatibility if a Windows FTP server returns file information to the
   `LIST` command with 24-hour times. Closes [#438](https://github.com/PyFilesystem/pyfilesystem2/issues/438).
+- Added Python 3.9 support. Closes [#443](https://github.com/PyFilesystem/pyfilesystem2/issues/443).
 
 ### Changed
 
@@ -30,25 +45,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   be able to see if we break something aside from known issues with FTP tests.
 - Include docs in source distributions as well as the whole tests folder,
   ensuring `conftest.py` is present, fixes [#364](https://github.com/PyFilesystem/pyfilesystem2/issues/364).
-- Stop patching copy with Python 3.8+ because it already uses `sendfile`.
+- Stop patching copy with Python 3.8+ because it already uses `sendfile`
+  ([#424](https://github.com/PyFilesystem/pyfilesystem2/pull/424)).
+  Closes [#421](https://github.com/PyFilesystem/pyfilesystem2/issues/421).
 
 ### Fixed
 
 - Fixed crash when CPython's -OO flag is used
-- Fixed error when parsing timestamps from a FTP directory served from a WindowsNT FTP Server, fixes [#395](https://github.com/PyFilesystem/pyfilesystem2/issues/395).
+- Fixed error when parsing timestamps from a FTP directory served from a WindowsNT FTP Server.
+  Closes [#395](https://github.com/PyFilesystem/pyfilesystem2/issues/395).
 - Fixed documentation of `Mode.to_platform_bin`. Closes [#382](https://github.com/PyFilesystem/pyfilesystem2/issues/382).
 - Fixed the code example in the "Testing Filesystems" section of the
   "Implementing Filesystems" guide. Closes [#407](https://github.com/PyFilesystem/pyfilesystem2/issues/407).
 - Fixed `FTPFS.openbin` not implicitly opening files in binary mode like expected
   from `openbin`. Closes [#406](https://github.com/PyFilesystem/pyfilesystem2/issues/406).
 
+
 ## [2.4.11] - 2019-09-07
 
 ### Added
 
 - Added geturl for TarFS and ZipFS for 'fs' purpose. NoURL for 'download' purpose.
-- Added helpful root path in CreateFailed exception [#340](https://github.com/PyFilesystem/pyfilesystem2/issues/340)
-- Added Python 3.8 support
+- Added helpful root path in CreateFailed exception.
+  Closes [#340](https://github.com/PyFilesystem/pyfilesystem2/issues/340).
+- Added Python 3.8 support.
 
 ### Fixed
 
@@ -76,7 +96,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- Fixed broken WrapFS.movedir [#322](https://github.com/PyFilesystem/pyfilesystem2/issues/322)
+- Fixed broken WrapFS.movedir [#322](https://github.com/PyFilesystem/pyfilesystem2/issues/322).
 
 ## [2.4.9] - 2019-07-28
 
@@ -458,7 +478,7 @@ No changes, pushed wrong branch to PyPi.
 
 ### Added
 
-- New `copy_if_newer' functionality in`copy` module.
+- New `copy_if_newer` functionality in `copy` module.
 
 ### Fixed
 
@@ -469,17 +489,17 @@ No changes, pushed wrong branch to PyPi.
 ### Changed
 
 - Improved FTP support for non-compliant servers
-- Fix for ZipFS implied directories
+- Fix for `ZipFS` implied directories
 
 ## [2.0.1] - 2017-03-11
 
 ### Added
 
-- TarFS contributed by Martin Larralde
+- `TarFS` contributed by Martin Larralde.
 
 ### Fixed
 
-- FTPFS bugs.
+- `FTPFS` bugs.
 
 ## [2.0.0] - 2016-12-07
 

CHANGELOG.md

@@ -2,15 +2,14 @@
 
 Python's Filesystem abstraction layer.
 
-[![PyPI version](https://badge.fury.io/py/fs.svg)](https://badge.fury.io/py/fs)
+[![PyPI version](https://img.shields.io/pypi/v/fs)](https://pypi.org/project/fs/)
 [![PyPI](https://img.shields.io/pypi/pyversions/fs.svg)](https://pypi.org/project/fs/)
-[![Downloads](https://pepy.tech/badge/fs/month)](https://pepy.tech/project/fs/month)
-
-
-[![Build Status](https://travis-ci.org/PyFilesystem/pyfilesystem2.svg?branch=master)](https://travis-ci.org/PyFilesystem/pyfilesystem2)
-[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/pyfilesystem/pyfilesystem2?branch=master&svg=true)](https://ci.appveyor.com/project/willmcgugan/pyfilesystem2)
-[![Coverage Status](https://coveralls.io/repos/github/PyFilesystem/pyfilesystem2/badge.svg)](https://coveralls.io/github/PyFilesystem/pyfilesystem2)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/30ad6445427349218425d93886ade9ee)](https://www.codacy.com/app/will-mcgugan/pyfilesystem2?utm_source=github.com&utm_medium=referral&utm_content=PyFilesystem/pyfilesystem2&utm_campaign=Badge_Grade)
+[![Downloads](https://pepy.tech/badge/fs/month)](https://pepy.tech/project/fs/)
+[![Build Status](https://img.shields.io/github/workflow/status/PyFilesystem/pyfilesystem2/Test/master?logo=github&cacheSeconds=600)](https://github.com/PyFilesystem/pyfilesystem2/actions?query=branch%3Amaster)
+[![Windows Build Status](https://img.shields.io/appveyor/build/willmcgugan/pyfilesystem2/master?logo=appveyor&cacheSeconds=600)](https://ci.appveyor.com/project/willmcgugan/pyfilesystem2)
+[![Coverage Status](https://img.shields.io/coveralls/github/PyFilesystem/pyfilesystem2/master?cacheSeconds=600)](https://coveralls.io/github/PyFilesystem/pyfilesystem2)
+[![Codacy Badge](https://img.shields.io/codacy/grade/30ad6445427349218425d93886ade9ee/master?logo=codacy)](https://www.codacy.com/app/will-mcgugan/pyfilesystem2?utm_source=github.com&utm_medium=referral&utm_content=PyFilesystem/pyfilesystem2&utm_campaign=Badge_Grade)
+[![Docs](https://img.shields.io/readthedocs/pyfilesystem2?maxAge=3600)](http://pyfilesystem2.readthedocs.io/en/stable/?badge=stable)
 
 ## Documentation
 

README.md

@@ -0,0 +1,3 @@
+# the bare requirements for building docs
+Sphinx ~=3.0
+sphinx-rtd-theme ~=0.5.1

docs/requirements.txt

@@ -304,3 +304,14 @@
 #texinfo_no_detailmenu = False
 
 napoleon_include_special_with_doc = True
+
+
+# -- Options for autodoc -----------------------------------------------------
+
+# Configure autodoc so that it doesn't skip building the documentation for
+# __init__ methods, since the arguments to instantiate classes should be in
+# the __init__ docstring and not at the class-level.
+
+autodoc_default_options = {
+    'special-members': '__init__',
+}