diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2f7aac5 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +.PHONY: readme +readme: + pandoc --from=markdown --to=rst --output=README.rst README.md + +.PHONY: release +release: readme + python setup.py sdist bdist_wheel upload + +.PHONY: test +test: + nosetests --with-coverage --cover-erase --cover-package=fs_s3fs fs_s3fs/tests + rm .coverage + +.PHONY: testall +testall: + tox + +.PHONY: docs +docs: + cd docs && make html + python -c "import os, webbrowser; webbrowser.open('file://' + os.path.abspath('./docs/build/html/index.html'))" diff --git a/README.md b/README.md index 15a7e16..e5663ea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ -# s3fs -Work in Progress S3 filesystem +# S3FS + +S3FS is a [PyFilesystem interface](https://docs.pyfilesystem.org/) to +Amazon S3 cloud storage. + +As a PyFilesystem concrete class, S3FS allows you to work with S3 in the +same as any other supported filesystem. \ No newline at end of file diff --git a/README.rst b/README.rst index 636031c..e589757 100644 --- a/README.rst +++ b/README.rst @@ -1 +1,8 @@ -Work in progress S3 Filesystem \ No newline at end of file +S3FS +==== + +S3FS is a `PyFilesystem interface `__ to +Amazon S3 cloud storage. + +As a PyFilesystem concrete class, S3FS allows you to work with S3 in the +same as any other supported filesystem. diff --git a/setup.py b/setup.py index 6530686..f16793f 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ exec(f.read()) CLASSIFIERS = [ - 'Development Status :: 5 - Production/Stable', + 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: OS Independent',