Rename bin/ to filecheck/

pull/21/head
Dan Puttick 2017-08-10 18:12:30 -04:00
parent 058a446d78
commit 7b275c7e6f
10 changed files with 11 additions and 11 deletions

View File

@ -79,7 +79,7 @@ install:
# - popd # - popd
script: script:
- travis_wait py.test --cov=kittengroomer --cov=bin tests/ - travis_wait py.test --cov=kittengroomer --cov=filecheck tests/
notifications: notifications:
email: email:

View File

@ -7,8 +7,8 @@ PyCIRCLean is the core Python code used by [CIRCLean](https://github.com/CIRCL/C
USB key and document sanitizer created by [CIRCL](https://www.circl.lu/). This module has been separated from the USB key and document sanitizer created by [CIRCL](https://www.circl.lu/). This module has been separated from the
device-specific scripts and can be used for dedicated security applications to sanitize documents from hostile environments device-specific scripts and can be used for dedicated security applications to sanitize documents from hostile environments
to trusted environments. PyCIRCLean is currently Python 3.3+ compatible. Also, while [kittengroomer](./kittengroomer) can to trusted environments. PyCIRCLean is currently Python 3.3+ compatible. Also, while [kittengroomer](./kittengroomer) can
run on any platform supported by python-magic/libmagic, [filecheck.py](./bin/filecheck.py) has some dependencies that are run on any platform supported by python-magic/libmagic, [filecheck.py](./filecheck/filecheck.py) has some dependencies that
Linux-only, and running the full test suite will require access to a Linux box or VM. are Linux-only, and running the full test suite will require access to a Linux box or VM.
# Installation # Installation
@ -30,7 +30,7 @@ and sanitization workflows in different organizations such as industrial
environments or restricted/classified ICT environments. A series of practical examples utilizing PyCIRCLean can be found environments or restricted/classified ICT environments. A series of practical examples utilizing PyCIRCLean can be found
in the [./examples](./examples) directory. Note: for commits beyond version 2.2.0 these in the [./examples](./examples) directory. Note: for commits beyond version 2.2.0 these
examples are out of date and not guaranteed to work with the PyCIRCLean API. Please check [helpers.py](./kittengroomer/ examples are out of date and not guaranteed to work with the PyCIRCLean API. Please check [helpers.py](./kittengroomer/
helpers.py) or [filecheck.py](./bin/filecheck.py) to see the new API interface. helpers.py) or [filecheck.py](./filecheck/filecheck.py) to see the new API interface.
The following simple example using PyCIRCLean will only copy files with a .conf extension matching the 'text/plain' The following simple example using PyCIRCLean will only copy files with a .conf extension matching the 'text/plain'
mimetype. If any other file is found in the source directory, the files won't be copied to the destination directory. mimetype. If any other file is found in the source directory, the files won't be copied to the destination directory.

View File

@ -17,7 +17,7 @@ from PIL import Image
from pdfid import PDFiD, cPDFiD from pdfid import PDFiD, cPDFiD
from kittengroomer import FileBase, KittenGroomerBase, Logging from kittengroomer import FileBase, KittenGroomerBase, Logging
from bin.config import Config from filecheck.config import Config
SEVENZ_PATH = '/usr/bin/7z' SEVENZ_PATH = '/usr/bin/7z'

View File

@ -1,6 +1,6 @@
import sys import sys
from bin.filecheck import File from filecheck.filecheck import File
PATH = 'tests/dangerous/bypass.docx' PATH = 'tests/dangerous/bypass.docx'

View File

@ -12,7 +12,7 @@ setup(
description='Standalone CIRCLean/KittenGroomer code.', description='Standalone CIRCLean/KittenGroomer code.',
packages=['kittengroomer'], packages=['kittengroomer'],
scripts=[ scripts=[
'bin/filecheck.py' 'filecheck/filecheck.py'
], ],
classifiers=[ classifiers=[
'License :: OSI Approved :: BSD License', 'License :: OSI Approved :: BSD License',

View File

@ -7,7 +7,7 @@ import pytest
import yaml import yaml
try: try:
from bin.filecheck import KittenGroomerFileCheck, File from filecheck.filecheck import KittenGroomerFileCheck, File
NODEPS = False NODEPS = False
except ImportError: except ImportError:
NODEPS = True NODEPS = True

View File

@ -7,7 +7,7 @@ from datetime import datetime
import pytest import pytest
try: try:
from bin.filecheck import KittenGroomerFileCheck from filecheck.filecheck import KittenGroomerFileCheck
NODEPS = False NODEPS = False
except ImportError: except ImportError:
NODEPS = True NODEPS = True