Prepare to package

This commit is contained in:
Elliot Nunn 2018-10-08 07:37:59 +08:00
parent 12cca25a70
commit 4b336343d8
9 changed files with 53 additions and 0 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2018 Elliot Nunn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

10
README.md Normal file
View File

@ -0,0 +1,10 @@
`machfs` is a pure Python 3 library for reading and writing disk images in the
Apple's long-deprecated [Hierarchical File
System](https://en.wikipedia.org/wiki/Hierarchical_File_System) format. It
operates entirely on in-memory `bytes` objects. Images are serialised and
deserialised in one go using the `read` and `write` methods of the `Volume`
object.
The directory hierarchy of a `Volume` is then accessed and manipulated like a
Python `dict`. `Folder` and `File` objects represent the contents of the
filesystem.

1
machfs/__init__.py Normal file
View File

@ -0,0 +1 @@
from main import Volume, Folder, File

21
setup.py Normal file
View File

@ -0,0 +1,21 @@
from distutils.core import setup
setup(
name='machfs',
version='0.1dev',
author='Elliot Nunn',
author_email='elliotnunn@me.com',
description='Library for reading and writing Macintosh HFS volumes',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',
license='MIT',
url='https://github.com/elliotnunn/machfs',
classifiers=[
'Programming Language :: Python :: 3 :: Only',
'Operating System :: OS Independent',
'License :: OSI Approved :: MIT License',
'Topic :: System :: Filesystems',
'Development Status :: 3 - Alpha',
],
packages=['machfs'],
)