aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.gitignore92
-rw-r--r--LICENSE674
-rw-r--r--MANIFEST.in1
-rw-r--r--README.md26
-rw-r--r--setup.cfg2
-rw-r--r--setup.py33
-rw-r--r--syncthingmanager/__init__.py477
-rw-r--r--syncthingmanager/conftest.py24
-rw-r--r--syncthingmanager/tests/test_stman.py67
9 files changed, 1396 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0a59023
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,92 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# vim swap files
+*.swp
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..9cecc1d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ {one line to give the program's name and a brief idea of what it does.}
+ Copyright (C) {year} {name of author}
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ {project} Copyright (C) {year} {fullname}
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..64ad321
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1 @@
+include README.md LICENSE
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a075b8d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# syncthingmanager
+A command line tool for the Syncthing API. Designed to make setting up remote servers easier.
+(and for users who prefer the cli)
+
+## Features
+- Adding and removing devices
+- Adding and removing folders
+- Sharing folders
+- More to come...
+
+## Usage
+The first time you use `stman`, you must give it the Syncthing API key.
+This can be found in the GUI or in the file `~/.config/syncthing/config.xml`.
+Then run `stman configure APIKEY`.
+
+All commands are documented in `stman -h`.
+
+## TODO
+- Untested on non-Linux platforms
+- More commands should be implemented, for changing the settings of existing
+folders and devices.
+- Should be able to find the API key automatically in most cases
+- Output of the device and folder listings could be prettier and more complete.
+- Tests are ugly and minimal, make them more systematic and complete.
+- You tell me! Open an issue and/or PR if you think a new command would be
+useful, or something unexpected happens.
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..b88034e
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..15c1074
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+
+setup(
+ name='syncthingmanager',
+ version='0.1.0',
+ description='A commandline tool for controlling the Syncthing API',
+ url ='https://github.com/classicsc/syncthingmanager',
+ author='Samuel Smoker',
+ author_email='smoker@usc.edu',
+ license='GPLv3',
+ classifiers = [
+ 'Development Status :: 3 - Alpha',
+ 'Intended Audience :: End Users/Desktop',
+ 'Intended Audience :: System Administrators',
+ 'Intended Audience :: Developers',
+ 'Topic :: System :: Archiving :: Mirroring',
+ 'Topic :: Utilities',
+ 'Natural Language :: English',
+ 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+ 'Programming Language :: Python :: 3.4',
+ ],
+ keywords = 'syncthing',
+ packages = ['syncthingmanager'],
+ install_requires = ['syncthing'],
+ extras_require={
+ 'test': ['pytest']
+ },
+ entry_points={
+ 'console_scripts': [
+ 'stman=syncthingmanager:main',
+ ],
+ },
+)
diff --git a/syncthingmanager/__init__.py b/syncthingmanager/__init__.py
new file mode 100644
index 0000000..5130ec2
--- /dev/null
+++ b/syncthingmanager/__init__.py
@@ -0,0 +1,477 @@
+""" A module providing high-level methods for the Syncthing API, and a script
+ using them. """
+# Copyright (C) 2017 Samuel Smoker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from syncthing import Syncthing, SyncthingError
+from argparse import ArgumentParser
+import configparser
+import pathlib
+import sys
+import os
+
+# Put globals here
+__NAME__ = 'syncthingmanager'
+__VERSION__ = '0.1.0'
+__DEFAULT_CONFIG_LOCATION__ = '~/.config/syncthingmanager/syncthingmanager.conf'
+
+# Some terminal colors
+HEADER = '\033[95m'
+OKBLUE = '\033[94m'
+OKGREEN = '\033[92m'
+WARNING = '\033[93m'
+FAIL = '\033[91m'
+ENDC = '\033[0m'
+
+class SyncthingManagerError(Exception):
+ pass
+
+
+class SyncthingManager(Syncthing):
+ def device_info(self, devicestr):
+ """ A helper for finding a device ID from a user string that may be a
+ deviceID a device name.
+
+ Args:
+ devicestr (str): the string that may be a deviceID or configured
+ device name.
+
+ Returns:
+ dict:
+ id: The deviceID in modern format, or None if not recogized.
+ index: the index of the device in config['devices'] in the
+ current configuration, or None if not configured.
+ folders: a list of folder IDs associated with the device."""
+
+ try:
+ device_id = self.misc.device_id(devicestr)
+ except SyncthingError:
+ device_id = None
+ deviceindex = None
+ device_name = None
+ config = self.system.config()
+ folders = []
+ if not device_id:
+ for index, device in enumerate(config['devices']):
+ if devicestr == device['name']:
+ device_name = device['name']
+ device_id = device['deviceID']
+ deviceindex = index
+ for folder in config['folders']:
+ for d in folder['devices']:
+ if d['deviceID'] == device_id:
+ folders.append(folder['id'])
+ else:
+ for index, device in enumerate(config['devices']):
+ if device_id == device['deviceID']:
+ deviceindex = index
+ device_name = device['name']
+ for folder in config['folders']:
+ for d in folder['devices']:
+ if device['deviceID'] == d['deviceID']:
+ folders.append(folder['id'])
+ return {'id': device_id, 'index': deviceindex, 'folders': folders,
+ 'name': device_name}
+
+ def folder_info(self, folderstr):
+ """Looks for a configured folder based on a user-input string and
+ returns some useful info about it. Looks for a matching ID first,
+ only considers labels if none is found. Further, duplicate labels
+ are not reported. The first matching label in the config is used.
+ Args:
+ folderstr (str): the folder ID or label
+ returns:
+ dict:
+ id: (str) the folder ID
+ index: (str) the index of the folder in the active configuration
+ label: (str) the folder label
+ devices: (list) the deviceIDs associated with the folder
+ None if no matching folder found """
+ config = self.system.config()
+ for index, folder in enumerate(config['folders']):
+ if folder['id'] == folderstr:
+ info = dict()
+ info['id'] = folder['id']
+ info['index'] = index
+ info['label'] = folder['label']
+ info['devices'] = folder['devices']
+ return info
+ for index, folder in enumerate(config['folders']):
+ if folder['label'] == folderstr:
+ info = dict()
+ info['id'] = folder['id']
+ info['index'] = index
+ info['label'] = folder['label']
+ info['devices'] = folder['devices']
+ return info
+ return None
+
+ def add_device(self, device_id, name='', address='', dynamic=False,
+ introducer=False):
+ """ Adds a device to the configuration and sets the configuration.
+ Args:
+ device_id (str): The device ID to be added.
+ name (str): The name of the device. default: ``''``
+ dynamic (bool): Add the ``dynamic`` entry to the addresses. No
+ effect if ``addresses`` is not specified. default: ``False``
+ introducer (bool): Give the device the introducer flag.
+ default: ``False``
+ Returns:
+ None """
+ config = self.system.config()
+ info = self.device_info(device_id)
+ if not info['id']:
+ raise SyncthingManagerError("Bad device ID: " + device_id)
+ if isinstance(info['index'], int):
+ raise SyncthingManagerError("Device already configured: " + device_id)
+ else:
+ addresses = [address]
+ if dynamic:
+ addresses.append('dynamic')
+ config['devices'].append(dict({'deviceID': info['id'], 'name': name,
+ 'addresses': addresses, 'compression': 'metadata',
+ 'certName': '', 'introducer': introducer}))
+ self.system.set_config(config)
+
+ def remove_device(self, devicestr):
+ """Removes a device from the configuration and sets it.
+ Args:
+ devicestr (str): The device ID or name.
+ Returns:
+ None
+ Raises: ``SyncthingManagerError``: when the given device is not
+ configured. """
+ config = self.system.config()
+ info = self.device_info(devicestr)
+ if info['index'] == None:
+ raise SyncthingManagerError("Device not configured: " + devicestr)
+ else:
+ del config['devices'][info['index']]
+ self.system.set_config(config)
+
+ def add_folder(self, path, folderid, label='', foldertype='readwrite',
+ rescan=60):
+ """Adds a folder to the configuration and sets it.
+ Args:
+ path (str): a path to the folder to be configured, either absolute
+ or relative to the cwd.
+ folderid (str): the string to identify the folder (must be same
+ on every device)
+ label (str): the label used as an alternate, local name for the
+ folder.
+ foldertype (str): see syncthing documentation...
+ rescan (int): the interval for scanning in seconds.
+ Returns:
+ None
+ Raises:
+ ``SyncthingManagerError``: when the path is invalid
+ ``SyncthingManagerError``: when a folder with identical label is
+ already configured. """
+ config = self.system.config()
+ # It's allowed to have a folder ID that matches another folder's label
+ # so we have to be careful about finding an in-use folder ID.
+ identicalid = lambda x: x['id'] == folderid
+ if next(filter(identicalid, config['folders']), None):
+ raise SyncthingManagerError("The folder ID " + folderid +
+ " is already in use")
+ else:
+ try:
+ path = pathlib.Path(path).resolve()
+ except pathlib.FileNotFoundError:
+ raise SyncthingManagerError("There was a problem with the path \
+ entered: " + path)
+ folder = dict({'id': folderid, 'label': label, 'path': str(path),
+ 'type': foldertype, 'rescanIntervalS': rescan, 'fsync': True,
+ 'autoNormalize': True, 'maxConflicts': 10, 'pullerSleepS': 0})
+ config['folders'].append(folder)
+ self.system.set_config(config)
+
+ def remove_folder(self, folderstr):
+ """Removes a folder from the configuration and sets it.
+ Args:
+ folderstr (str): an item from user input that may be the folder ID
+ or label.
+ Returns:
+ None"""
+ info = self.folder_info(folderstr)
+ if not info:
+ raise SyncthingManagerError(folderstr + " is not the ID or label "
+ + "of a configured folder.")
+ config = self.system.config()
+ del config['folders'][info['index']]
+ self.system.set_config(config)
+
+ def share_folder(self, folderstr, devicestr):
+ """ Adds a device to a folder's list of devices and sets the
+ configuration.
+ Args:
+ folderstr (str): an item from user input that may be the folder ID
+ or label.
+ devicestr (str): an item from user input that may be the device ID
+ or name.
+ Returns:
+ None """
+ info = self.folder_info(folderstr)
+ if not info:
+ raise SyncthingManagerError(folderstr + " is not the ID or label "
+ + "of a configured folder.")
+ deviceinfo = self.device_info(devicestr)
+ if deviceinfo['index'] == None:
+ raise SyncthingManagerError(devicestr + " is not a configured"
+ + " device name or ID")
+ for device in info['devices']:
+ if device['deviceID'] == deviceinfo['id']:
+ raise SyncthingManagerError(devicestr + " is already "
+ + "associated with " + folderstr)
+ config = self.system.config()
+ info['devices'].append(dict({'deviceID': deviceinfo['id']}))
+ config['folders'][info['index']]['devices'] = info['devices']
+ self.system.set_config(config)
+
+ def unshare_folder(self, folderstr, devicestr):
+ """ Removes a device from a folder's list of devices and sets the
+ configuration.
+ Args:
+ folderstr (str): an item from user input that may be the folder ID
+ or label.
+ devicestr (str): an item from user input that may be the device ID
+ or name.
+ Returns:
+ None """
+ info = self.folder_info(folderstr)
+ if not info:
+ raise SyncthingManagerError(folderstr + " is not the ID or label \
+ of a configured folder.")
+ deviceinfo = self.device_info(devicestr)
+ if deviceinfo['index'] == None:
+ raise SyncthingManagerError(devicestr + " is not a configured \
+ device name or ID")
+ config = self.system.config()
+ for index, device in enumerate(info['devices']):
+ if device['deviceID'] == deviceinfo['id']:
+ del info['devices'][index]
+ config['folders'][info['index']]['devices'] = info['devices']
+ self.system.set_config(config)
+ return
+ raise SyncthingManagerError(devicestr + " is not associated with "
+ + folderstr)
+
+ def _device_list(self):
+ """Prints out a formatted list of devices and their state from the
+ active configuration."""
+ config = self.system.config()
+ connections = self.system.connections()['connections']
+ connected = filter(lambda x: connections[x['deviceID']]['connected'],
+ config['devices'])
+ not_connected = filter(lambda x: x not in connected, config['devices'])
+ for device in connected:
+ address = connections[device['deviceID']]['address']
+ folders = self.device_info(device['deviceID'])['folders']
+ #TODO Figure out the sync percentage per device. Probably from
+ # events API.
+ #if complete == 100:
+ # sync = '\tUp to Date'
+ #else:
+ # sync = '\tSyncing (' + str(complete) + '%)'
+ sync = '\tConnected'
+ print(device['name'] + OKGREEN + sync + ENDC)
+ print('\tAt:\t' + address)
+ print('\tFolders:\t' + ','.join(map(str,folders)))
+
+ for device in not_connected:
+ folders = self.device_info(device['deviceID'])['folders']
+ print(device['name'] + FAIL + ' Not Connected' + ENDC)
+ print('\tFolders:\t' + ','.join(map(str,folders)))
+
+ def _folder_list(self):
+ """Prints out a formatted list of folders from the configuration."""
+ config = self.system.config()
+ for folder in config['folders']:
+ devices = []
+ for device in folder['devices']:
+ name = self.device_info(device['deviceID'])['name']
+ devices.append(name)
+ if folder['label'] == '':
+ folderstr = folder['id']
+ else:
+ folderstr = folder['label']
+ print(folderstr)
+ print('\tConnected devices: ' + ','.join(map(str, devices)))
+
+
+
+def arguments():
+ parser = ArgumentParser()
+ parser.add_argument('--config', '-c', default=__DEFAULT_CONFIG_LOCATION__,
+ help="stman configuration file")
+ base_subparsers = parser.add_subparsers(dest='subparser_name',
+ metavar='action')
+ base_subparsers.required = True
+
+ configuration_parser = base_subparsers.add_parser('configure',
+ help="configure stman. If the configuration file specified in " +
+ "-c (or the default) does not exist, it will be created. To edit an " +
+ "existing configuration, specify all options again.")
+ configuration_parser.add_argument('APIkey', help="the Syncthing API key, "
+ + "found in the GUI or config.xml")
+ configuration_parser.add_argument('--hostname', '-a', default='localhost',
+ help="the hostname to use. default localhost.")
+ configuration_parser.add_argument('--port', '-p', default='8384',
+ help="the port to use. Default 8384")
+ configuration_parser.add_argument('--name', '-n',
+ help="what to call this device. Defaults to the hostname.")
+ configuration_parser.add_argument('--default', action='store_true',
+ help="make this device the default.")
+
+ device_parser = base_subparsers.add_parser('device',
+ help="work with devices")
+ device_subparsers = device_parser.add_subparsers(dest='deviceparser_name',
+ metavar='ACTION')
+ device_subparsers.required = True
+ add_device_parser = device_subparsers.add_parser('add',
+ help="configure a device")
+ add_device_parser.set_defaults(name='', address='')
+ add_device_parser.add_argument('deviceID', metavar='DEVICEID', help="the deviceID to be configured.")
+ add_device_parser.add_argument('-n', '--name', help="a short name for the device.")
+ add_device_parser.add_argument('-d', '--dynamic', action='store_true',
+ help="adds 'dynamic' to the list of hosts. Unnecessary if no hostname specified.")
+ add_device_parser.add_argument('-a', '--address',
+ help="hostname, including leading 'tcp://'. Default dynamic.")
+ add_device_parser.add_argument('-i', '--introducer', action='store_true',
+ help="makes this device an introducer.")
+
+ list_device_parser = device_subparsers.add_parser('list',
+ help="prints a list of devices and some information")
+
+ remove_device_parser = device_subparsers.add_parser('remove',
+ help="remove a device")
+ remove_device_parser.add_argument('device', metavar='DEVICE', help="the name or ID to be removed")
+
+ folder_parser = base_subparsers.add_parser('folder',
+ help="work with folders")
+ folder_subparsers = folder_parser.add_subparsers(dest='folderparser_name',
+ metavar='action')
+ folder_subparsers.required = True
+ add_folder_parser = folder_subparsers.add_parser('add',
+ help="Configure a folder")
+ add_folder_parser.add_argument('path', metavar='PATH', help="path to the folder to be added")
+ add_folder_parser.add_argument('folderID', metavar='ID',
+ help="the folder ID. Must match the one used on all cluster devices.")
+ add_folder_parser.add_argument('--label', '-l', help="a local name for the folder")
+ add_folder_parser.add_argument('--foldertype', '-t', default='readwrite',
+ help="'readwrite' or 'readonly'. Default readwrite")
+ add_folder_parser.add_argument('--rescan-interval', '-r', default=60,
+ help='time in seconds between scanning for changes. Default 60.')
+
+ remove_folder_parser = folder_subparsers.add_parser('remove',
+ help='Remove a folder')
+ remove_folder_parser.add_argument('folder', metavar='FOLDER',
+ help='either the folder ID or label')
+
+ share_folder_parser = folder_subparsers.add_parser('share',
+ help='Share a folder')
+ share_folder_parser.add_argument('folder', metavar='FOLDER', help='the folder ID or label')
+ share_folder_parser.add_argument('device', metavar='DEVICE', help='the device ID or label')
+
+ unshare_folder_parser = folder_subparsers.add_parser('unshare',
+ help='Stop sharing folder with device')
+ unshare_folder_parser.add_argument('folder', metavar='FOLDER', help='the folder ID or label')
+ unshare_folder_parser.add_argument('device', metavar='DEVICE', help='the device ID or label')
+
+ list_folder_parser = folder_subparsers.add_parser('list', help='prints a list of configured folders')
+
+ return parser.parse_args()
+
+def configure(configfile, apikey, hostname, port, name, default):
+ config = configparser.ConfigParser()
+ configfile = os.path.expanduser(configfile)
+ if not name:
+ name = hostname
+ # Initialization of a config file
+ if not os.path.exists(configfile):
+ try:
+ os.makedirs(os.path.dirname(configfile), exist_ok=True)
+ except OSError:
+ raise SyncthingManagerError("Couldn't create a path to " + configfile)
+ config['DEFAULT'] = {}
+ config['DEFAULT']['Name'] = name
+ config.read(configfile)
+ config[name] = {}
+ config[name]['APIkey'] = apikey
+ config[name]['Hostname'] = hostname
+ config[name]['Port'] = str(port)
+ if default:
+ config['DEFAULT']['Name'] = name
+ try:
+ with open(configfile, 'w') as cfg:
+ config.write(cfg)
+ except OSError:
+ raise SyncthingManagerError("Couldn't write to the config file " + configfile)
+
+def getAPIInfo(configfile, name='DEFAULT'):
+ if not os.path.exists(os.path.expanduser(configfile)):
+ raise SyncthingManagerError(configfile + " doesn't appear to be a valid path. Exiting.")
+ config = configparser.ConfigParser()
+ config.read(os.path.expanduser(configfile))
+ if name == 'DEFAULT':
+ return config[config['DEFAULT']['Name']]
+ try:
+ return config[name]
+ except KeyError:
+ raise SyncthingManagerError("The Syncthing daemon specified"
+ + " is not configured.")
+
+def main():
+ try:
+ args = arguments()
+ if args.subparser_name == 'configure':
+ configure(args.config, args.APIkey, args.hostname, args.port,
+ args.name, args.default)
+ sys.exit(0)
+ if not getAPIInfo(args.config):
+ raise SyncthingManagerError("No Syncthing daemon is configured. Use "
+ + "stman configure apikey to initialize a configuration (apikey" +
+ " is in the syncthing settings and config.xml)")
+ APIInfo = getAPIInfo(args.config)
+ st = SyncthingManager(APIInfo['APIkey'], APIInfo['Hostname'], APIInfo['Port'])
+ if args.subparser_name == 'device':
+ if args.deviceparser_name == 'add':
+ st.add_device(args.deviceID, args.name, args.address,
+ args.dynamic, args.introducer)
+ elif args.deviceparser_name == 'remove':
+ st.remove_device(args.device)
+ elif args.deviceparser_name == 'list':
+ st._device_list()
+ elif args.subparser_name == 'folder':
+ if args.folderparser_name == 'add':
+ st.add_folder(args.path, args.folderID, args.label,
+ args.foldertype, args.rescan_interval)
+ elif args.folderparser_name == 'remove':
+ st.remove_folder(args.folder)
+ elif args.folderparser_name == 'share':
+ st.share_folder(args.folder, args.device)
+ elif args.folderparser_name == 'unshare':
+ st.unshare_folder(args.folder, args.device)
+ elif args.folderparser_name == 'list':
+ st._folder_list()
+ except SyncthingError as err:
+ print(err)
+ sys.exit(1)
+ except SyncthingManagerError as err:
+ print(err)
+ sys.exit(1)
+
+if __name__ == '__main__':
+ main()
diff --git a/syncthingmanager/conftest.py b/syncthingmanager/conftest.py
new file mode 100644
index 0000000..cc65eb3
--- /dev/null
+++ b/syncthingmanager/conftest.py
@@ -0,0 +1,24 @@
+import syncthingmanager as stman
+import pytest
+
+@pytest.fixture(scope='session')
+def temp_folder(tmpdir_factory):
+ return tmpdir_factory.mktemp('stmantest1')
+
+@pytest.fixture()
+def s(request, temp_folder):
+ APIInfo = stman.getAPIInfo(stman.__DEFAULT_CONFIG_LOCATION__)
+ s = stman.SyncthingManager(APIInfo['APIkey'], APIInfo['Hostname'], APIInfo['Port'])
+ cfg = s.system.config()
+ cfga = s.system.config()
+ test_device = {'deviceID': 'MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD',
+ 'name': 'SyncthingManagerTestDevice1', 'addresses': ['localhost']}
+ test_folder = {'id': 'stmantest1', 'label': 'SyncthingManagerTestFolder1',
+ 'path': str(temp_folder), 'type': 'readwrite', 'rescanIntervalS': 60,
+ 'devices': []}
+ cfg['devices'].append(test_device)
+ cfg['folders'].append(test_folder)
+ s.system.set_config(cfg)
+ yield s
+ cfg = cfga
+ s.system.set_config(cfg)
diff --git a/syncthingmanager/tests/test_stman.py b/syncthingmanager/tests/test_stman.py
new file mode 100644
index 0000000..e8230dc
--- /dev/null
+++ b/syncthingmanager/tests/test_stman.py
@@ -0,0 +1,67 @@
+from unittest import TestCase
+
+def test_device_info(s):
+ tc = TestCase()
+ info = s.device_info('SyncthingManagerTestDevice1')
+ tc.assertCountEqual(['id', 'index', 'folders', 'name'], list(info.keys()))
+ assert info['index'] != None
+ assert info['folders'] == []
+
+def test_folder_info(s):
+ tc = TestCase()
+ info = s.folder_info('SyncthingManagerTestFolder1')
+ tc.assertCountEqual(['id', 'index', 'devices', 'label'], list(info.keys()))
+ assert len(info['devices']) == 1
+ info = s.folder_info('stmantest1')
+ tc.assertCountEqual(['id', 'index', 'devices', 'label'], list(info.keys()))
+
+def test_add_device(s):
+ s.add_device('MRIW7OK-NETT3M4-N6SBWME-N25O76W-YJKVXPH-FUMQJ3S-P57B74J-GBITBAC',
+ 'SyncthingManagerTestDevice2', '127.0.0.1', True, True)
+ cfg = s.system.config()
+ found = False
+ for device in cfg['devices']:
+ if device['deviceID'] == 'MRIW7OK-NETT3M4-N6SBWME-N25O76W-YJKVXPH-FUMQJ3S-P57B74J-GBITBAC':
+ found = True
+ assert device['introducer']
+ assert 'dynamic' in device['addresses']
+ assert found
+
+def test_remove_device(s):
+ cfg = s.system.config()
+ a = filter(lambda x: x['name'] == 'SyncthingManagerTestDevice1', cfg['devices'])
+ assert next(a, False)
+ s.remove_device('SyncthingManagerTestDevice1')
+ cfg = s.system.config()
+ b = filter(lambda x: x['name'] == 'SyncthingManagerTestDevice1', cfg['devices'])
+ assert not next(b, False)
+
+def test_add_folder(s, temp_folder):
+ p = temp_folder
+ s.add_folder(str(p), 'stmantest2', 'SyncthingManagerTestFolder2', 'readonly', 40)
+ cfg = s.system.config()
+ found = False
+ for folder in cfg['folders']:
+ if folder['id'] == 'stmantest2':
+ found = True
+ assert folder['type'] == 'readonly'
+ assert folder['rescanIntervalS'] == 40
+ assert found
+
+def test_remove_folder(s):
+ cfg = s.system.config()
+ a = filter(lambda x: x['id'] == 'stmantest1', cfg['folders'])
+ assert next(a, False)
+ s.remove_folder('stmantest1')
+ cfg = s.system.config()
+ b = filter(lambda x: x['id'] == 'stmantest1', cfg['folders'])
+ assert not next(b, False)
+
+def test_share_folder(s):
+ cfg = s.system.config()
+ a = filter(lambda x: x['id'] == 'stmantest1', cfg['folders'])
+ s.share_folder('stmantest1', 'SyncthingManagerTestDevice1')
+ cfg = s.system.config()
+ b = filter(lambda x: x['id'] == 'stmantest1', cfg['folders'])
+ assert len(next(a)['devices']) == 1
+ assert len(next(b)['devices']) == 2
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-21 18:44:47 +0000