File: README

package info (click to toggle)
pytagsfs 0.9.2-6
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 984 kB
  • ctags: 1,858
  • sloc: python: 10,656; xml: 543; makefile: 47
file content (108 lines) | stat: -rw-r--r-- 3,030 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
===============
pytagsfs README
===============

-----------------------
http://www.pytagsfs.org
-----------------------


pytagsfs is a FUSE filesystem that arranges media files in a virtual directory
structure based on the file tags. For instance, a set of audio files could be
mapped to a new directory structure organizing them hierarchically by album,
genre, release date, etc. File tags can be changed by moving and renaming
virtual files and directories. The virtual files can also be modified directly,
and, of course, can be opened and played just like regular files.

This file may be distributed under the same license as pytagsfs itself.


Dependencies
============

pytagsfs has the following dependencies:

 * Python (2.4, 2.5, or 2.6): http://www.python.org/
 * sclapp (>= 0.5.2): http://www.alittletooquiet.net/software/sclapp
 * python-fuse (>= 0.2): http://fuse.sourceforge.net/wiki/index.php/FusePython
 * mutagen: http://www.sacredchao.net/quodlibet/wiki/Development/Mutagen

One of the following filesystem monitoring libraries should also be installed:

 * inotifyx (Linux only): http://www.alittletooquiet.net/software/inotifyx/
 * py-kqueue (Darwin, FreeBSD, NetBSD, OpenBSD):
   http://pypi.python.org/packages/source/p/py-kqueue/
 * gamin (many Unix-like systems, inotifyx and py-kqueue are preferred):
   http://www.gnome.org/~veillard/gamin/

To run the test suite, the following additional dependencies must be fulfilled:

 * madplay: http://www.underbit.com/products/mad/
 * vorbis-tools (for ogg123): http://www.vorbis.com/
 * flac: http://flac.sourceforge.net/
 * ctypes (Python 2.4 only): http://python.net/crew/theller/ctypes/


Installing
==========

Before installing from source, check if your distribution has packages
available.  It is not normally recommended that you install packages from
source in system-wide directories, unless you know what you're doing.

To build::

  ./setup.py build

To install::

  ./setup.py install

To clean up temporary files created while building or testing::

  ./setup.py clean

To clean all files, including built files that are required for installation::

  ./setup.py clean --all


Documentation
=============

Manual pages for both the pytagsfs and pytags commands are built via ``setup.py
build``.  Please refer to those, as well as the pytagsfs website, for
documentation.


Running Tests
=============

Tests can be run via setup.py::

  ./setup.py test

Specific tests can be specified on the command-line.  For instance, to only run
tests defined in module tests.subspat::

  ./setup.py test --tests tests.subspat

To only run tests defined by test case ShortKeySubstitutionPatternTestCase::

  ./setup.py test --tests tests.subspat.ShortKeySubstitutionPatternTestCase

To only run a specific test defined by that test case::

  ./setup.py test --tests tests.subspat.ShortKeySubstitutionPatternTestCase.testSplit

Multiple identifiers can be specified using a comma-separated list.


See Also
========

* AUTHORS
* BUGS
* COPYING
* NEWS
* TODO