| Name | ataraxis-automation JSON |
| Version |
3.0.4
JSON |
| download |
| home_page | None |
| Summary | Provides scripts that support tox-based development automation pipelines used by other Sun Lab projects. |
| upload_time | 2024-07-22 01:41:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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: <program> Copyright (C) <year> <name of author> 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 <https://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 <https://www.gnu.org/licenses/why-not-lgpl.html>. |
| keywords |
ataraxis
automation
development-tools
tox
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ataraxis-automation
A Python library that provides scripts that support tox-based development automation pipelines used by other
Sun Lab projects.
[](https://github.com/astral-sh/uv)
[](https://github.com/astral-sh/ruff)
___
## Detailed Description
This library is one of the two 'base' dependency libraries used by every other Sun Lab project (the other being
[ataraxis-base-utilities](https://github.com/Sun-Lab-NBB/ataraxis-base-utilities)). It exposes a command-line interface
(automation-cli) that can be used through the [tox-based](https://tox.wiki/en/latest/user_guide.html) project
development automation suite that comes with every Sun Lab project (we use tox as an analog to build system).
The commands from this library generally fulfill two major roles. First, they are used to set up, support,
or clean up after third-party packages (ruff, mypy, stubgen, grayskull, etc.) used by our tox tasks. Second, they
automate most operations with conda environments, such as creating / removing the environment and
installing / uninstalling the project from the environment.
The library can be used as a standalone module, but it is primarily designed to integrate with other Sun Lab projects,
providing development automation functionality. Therefore, it may require either adopting and modifying a
tox automation suite from one of the lab projects or significant refactoring to work with non-lab projects.
___
## Features
- Supports Windows, Linux, and OSx.
- Optimized for runtime speed by preferentially using mamba and uv over conda and pip.
- Compliments the extensive suite of tox-automation tasks used by all Sun Lab projects.
- Pure-python API.
- GPL 3 License.
___
## Table of Contents
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Developers](#developers)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Acknowledgements](#Acknowledgments)
___
## Dependencies
For users, all library dependencies are installed automatically for all supported installation methods
(see [Installation](#installation) section). For developers, see the [Developers](#developers) section for
information on installing additional development dependencies.
___
## Installation
### Source
1. Download this repository to your local machine using your preferred method, such as git-cloning. Optionally, use one
of the stable releases that include precompiled binary wheels in addition to source code.
2. ```cd``` to the root directory of the project using your command line interface of choice.
3. Run ```python -m pip install .``` to install the project. Alternatively, if using a distribution with precompiled
binaries, use ```python -m pip install WHEEL_PATH```, replacing 'WHEEL_PATH' with the path to the wheel file.
### PIP
Use the following command to install the library using PIP: ```pip install ataraxis-automation```
### Conda / Mamba
**_Note. Due to conda-forge contributing process being more nuanced than pip uploads, conda versions may lag behind
pip and source code distributions._**
Use the following command to install the library using Conda or Mamba: ```conda install ataraxis-automation```
___
## Usage
### Quickstart
The easiest way to get Sun Lab automation to work for your project is to initialize the project using one of our
templates for
[pure-python](https://github.com/Sun-Lab-NBB/pure-python-template) or
[c-extension](https://github.com/Sun-Lab-NBB/c-python-template) projects. To initialize and customize one of our
templates, follow these steps:
1. Navigate to the desired template via one of the links above and click ```Use this template``` button in the
top right corner of the page.
2. Initialize your project as necessary and download and unpack it on your local machine. To do this, you can use tools
such as git-cloning.
3. ```cd``` into the root directory of the project.
4. Use the ```tox -e adopt``` command to 'adopt' the project. The adoption process replaces placeholder markers in the
template 'meta' files with information appropriate for your project.
5. Add your source code and support files as needed.
### Automation Command-Line Interface
All library functions designed to be called by end-users are exposed through the 'automation-cli' script.
This cli script is automatically exposed after installing the library into a conda or virtual environment.
#### Automation-CLI
While the preferred use case for this library is via 'tox' tasks, you can access all functions supplied by the library
by calling ```automation-cli``` from the shell that has access to the python environment with the library. Here are
some examples of how you can use the automation-cli directly:
- Use ```automation-cli --help``` to verify that the cli is available and to see the list of supported commands.
- Use ```automation-cli COMMAND-NAME --help``` to display additional information about a specific command. For example:
```automation-cli import-env --help```.
#### Tox automation
This library is intended to be used to augment 'tox' runtimes, and this is always the preferred use case.
To use any of the commands as part of a tox 'task,' add it to the 'commands' section of the tox.ini:
```
[testenv:create]
basepython = py310
deps =
ataraxis-automation>=3,<4
description =
Creates a minimally-configured conda environment using the requested python version and installs conda- and pip-
dependencies extracted from pyproject.toml file into the environment. Does not install the project!
commands =
automation-cli --verbose create-env --environment-name axa_dev --python-version 3.12
```
#### Logging and Printing
All cli commands come with two parameters exposed through the main cli group:
1. ```--verbose```: Determines whether to display Information, Warning and Success messages to inform the user about
the ongoing runtime.
2. ```--log```: Determines whether to save messages and errors to log files (located in automatically generated folder
inside user log directory).
#### Command-specific flags
*__Note!__* Many sub-commands of the cli have additional flags and arguments that can be used to further customize
their runtime. Consult the API documentation to see these options with detailed descriptions.
*__Warning!__* When using any cli command that uses ```--python-version``` flag from tox, you __have__ to include
```basepython=``` line in the environment configuration __and__ set it to a python version __different__ from the
one provided after ```--python-version``` argument. See the 'testenv:create' example above.
### Intended cli use pattern
All cli commands are intended to be used through tox pipelines. The most recent version of Sun Lab tox configuration
is always available from this libraries' [tox.ini file](tox.ini). Since this library plays a large role in our tox
automation pipelines, its tox configuration is always the most up to date and feature-packed compared to all other
Sun Lab projects.
Any well-maintained Sun Lab project comes with an up-to-date tox configuration that automates most 'meta'
development steps, such as code formatting, project testing, and project distribution. By automating most of these
steps, we seek to provide clear standards to be shared by internal and external collaborators. Additionally, this
allows developers to focus on the important task of planning and writing the code of their projects over 'meta' tasks
like code formatting.
### Available 'tox' commands
This library is tightly linked to our 'tox' configuration. Most of our 'tox' tasks either use some functions from this
library in addition to external packages or entirely consist of calling functions from this library. Therefore, this
documentation would not have been complete without having a section about our 'tox' tasks, in addition to the basic
information about our 'automation-cli' script.
Note that commands listed here may and frequently are modified based on the specific needs of each project that
uses them. Therefore, this section is *__not__* a replacement for studying the tox.ini file for the specific project you
seek to develop. Additionally, using tasks listed here 'as is' may not work for your project without customizations.
Most of the commands in this section are designed to be executed together (some sequentially, some in-parallel) when
a general ```tox``` command is used. These are considered 'checkout' tasks, and they generally cover the things that
need to be present for a commit to be pushed to the main branch of any Sun Lab project.
#### Lint
Shell command: ```tox -e lint```
Uses [ruff](https://github.com/astral-sh/ruff) and [mypy](https://github.com/python/mypy) to statically analyze and,
where possible, fix code formatting, typing, and problematic use patterns. This helps to ensure the code is
formatted according to our standards and does not contain easily identifiable problematic use patterns, such as
type violations. As part of its runtime, this task uses automation cli to remove existing stub (.pyi) files from
the source folders, as they interfere with type-checking.
Example tox.ini section:
```
[testenv: lint]
description =
Runs static code formatting, style and typing checkers. Mypy may not work properly until py.typed marker is
added by 'stubs' task.
deps =
mypy>=1,<2
ruff>=0,<1
types-pyyaml>=6,<7
ataraxis-automation>=3,<4
depends = uninstall
# Note! Basepython has to be set to the 'lowest' version supported by your project
basepython = py310
commands =
automation-cli --verbose purge-stubs
ruff check --select I --fix
ruff format
mypy . --strict --extra-checks --warn-redundant-cast
```
#### Stubs
Shell command: ```tox -e stubs```
Uses [stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html) to generate stub (.pyi) files and,
via automation-cli, distribute them to the appropriate levels of the library source folder. This is necessary to
support static type-checking for projects that use your project. As part of that process, automation-cli also ensures
that there is a 'py.typed' marker file in the highest library directory. This is required for type-checkers like mypy
to recognize the project as 'typed' and process it during type-checking tasks.
Example tox.ini section:
```
[testenv: stubs]
description =
Generates the py.typed marker and the stub files using the built library wheel. Formats the stubs with ruff before
moving them to appropriate source sub-directories.
deps =
mypy>=1,<2
ruff>=0,<1
ataraxis-automation>=3,<4
depends = lint
commands =
automation-cli --verbose process-typed-markers
stubgen -o stubs --include-private --include-docstrings -p ataraxis_automation -v
ruff check --select I --fix
ruff format
automation-cli --verbose process-stubs
```
#### Test
Shell command: ```tox -e pyXXX-test```
This task is available for all python versions supported by each project. For example, automation supports versions
3.10, 3.11, and 3.12. Therefore, it will have ```tox -e py310-test```, ```tox -e py311-test``` and
```tox -e py312-test``` as valid 'test' tasks. These tasks are used to build the project in an isolated environment and
run the tests expected to be located inside the project_root/tests directory to verify the project works as expected
for each python version. This is especially relevant for c-extension projects that compile code for specific python
versions and platforms.
Example tox.ini section:
```
[testenv: {py310, py311, py312}-test]
package = wheel
description =
Runs unit and integration tests for each of the python versions listed in the task name. Uses 'loadgroup' balancing
and all logical cores to optimize runtime speed while allowing manual control over which cores execute tasks (see
pytest-xdist documentation).
deps =
pytest>=8,<9
pytest-cov>=5,<6
pytest-xdist>=3,<4
coverage[toml]>=7,<8
depends = uninstall
setenv =
# Sets environment parameters, which includes intermediate coverage aggregation file used by coverage.
COVERAGE_FILE = reports{/}.coverage.{envname}
commands =
# Make sure the --cov is always set to the intended library name, so that coverage runs on the whole library
# exactly once.
pytest --import-mode=append --cov=ataraxis_automation --cov-config=pyproject.toml --cov-report=xml \
--junitxml=reports/pytest.xml.{envname} -n logical --dist loadgroup
```
#### Coverage
Shell command: ```tox -e coverage```
This task is designed to be used in-conjunction with the 'test' task. It aggregates code coverage data for different
python versions and compiles it into a html-report accessible by opening project_root/reports/coverage_html/index.html
in a browser. For all lab projects, we try to provide as close to 100% code coverage as possible for each project.
Example tox.ini section:
```
[testenv:coverage]
skip_install = true
description =
Combines test-coverage data from multiple test runs (for different python versions) into a single html file. The
file can be viewed by loading the 'reports/coverage_html/index.html'.
setenv = COVERAGE_FILE = reports/.coverage
depends = {py310, py311, py312}-test
deps =
junitparser>=3,<4
coverage[toml]>=7,<8
commands =
junitparser merge --glob reports/pytest.xml.* reports/pytest.xml
coverage combine --keep
coverage xml
coverage html
```
#### Doxygen
Shell command: ```tox -e doxygen```
*__Note!__* This task is only used in c-extension projects.
This task is unique to our c-extension projects (projects that contain compiled c / c++ code). It uses
[Doxygen](https://www.doxygen.nl/) to parse doxygen-styled docstrings used in our c-code to make them accessible to
[Sphinx](https://www.sphinx-doc.org/en/master/) (used as part of our 'docs' task). This allows automatically building
C/C++ API documentation and organically bundling it with Python API documentation via sphinx.
Example tox.ini section:
```
[testenv:doxygen]
skip_install = true
description =
Generates C++ / C source code documentation using Doxygen. This assumes the source code uses doxygen-compatible
docstrings and that the root directory contains a Doxyfile that minimally configures Doxygen runtime.
allowlist_externals = doxygen
depends = uninstall
commands =
doxygen Doxyfile
```
#### Docs
Shell command: ```tox -e docs```
Uses [sphinx](https://www.sphinx-doc.org/en/master/) to automatically parse docstrings from source code and use them
to build API documentation for the project. C-extension projects use a slightly modified version of this task that uses
[breathe](https://breathe.readthedocs.io/en/latest/) to convert doxygen-generated xml files for c-code into a format
that sphinx can parse. This way, c-extension projects can include both Python and C/C++ API documentation as part of
the same file. This task relies on the configuration files stored inside /project_root/docs/source folder to define
the generated documentation format. Built documentation can be viewed by opening
project_root/docs/build/html/index.html in a browser.
Example tox.ini section for a pure-python project:
```
[testenv:docs]
description =
Builds the API documentation from source code docstrings using Sphinx. The result can be viewed by loading
'docs/build/html/index.html'.
depends = uninstall
deps =
sphinx>=7,<8
importlib_metadata>=8,<9
sphinx-rtd-theme>=2,<3
sphinx-click>=6,<7
sphinx-autodoc-typehints>=2,<3
commands =
sphinx-build -b html -d docs/build/doctrees docs/source docs/build/html -j auto -v
```
Example tox.ini section for a c-extension project:
```
[testenv:docs]
description =
Builds the API documentation from source code docstrings using Sphinx. Integrates with C / C++ documentation via
Breathe, provided that Doxygen was used to generate the initial .xml file for C-extension sources. The result can
be viewed by loading 'docs/build/html/index.html'.
depends = doxygen
deps =
sphinx>=7,<8
importlib_metadata>=8,<9
sphinx-rtd-theme>=2,<3
sphinx-click>=6,<7
sphinx-autodoc-typehints>=2,<3
breathe>=4,<5
commands =
sphinx-build -b html -d docs/build/doctrees docs/source docs/build/html -j auto -v
```
#### Build
Shell command: ```tox -e build```
This task differs for c-extension and pure-python projects. In both cases, it builds a source-code distribution (sdist)
and a binary distribution (wheel) for the project. These distributions can then be uploaded to GitHub, PyPI, and Conda
for further distribution or shared with other people manually. Pure Python projects use
[hatchling](https://hatch.pypa.io/latest/) and [build](https://build.pypa.io/en/stable/) to generate
one source-code and one binary distribution. C-extension projects use
[cibuildwheel](https://cibuildwheel.pypa.io/en/stable/) to compile c-code for all supported platforms and
architectures, building many binary distribution files alongside source-code distribution generated via build.
Example tox.ini section for a pure-python project:
```
[testenv:build]
skip-install = true
description =
Builds the source code distribution (sdist) and the binary distribution package (wheel). Use 'upload' task to
subsequently upload built wheels to PIP.
deps =
build>=1,<2
hatchling>=1,<2
allowlist_externals =
docker
commands =
python -m build . --sdist
python -m build . --wheel
```
Example tox.ini section for a c-extension project:
```
[testenv:build]
skip-install = true
description =
Builds the source code distribution (sdist) and compiles and assembles binary wheels for all architectures of the
host-platform supported by the library. Use 'upload' task to subsequently upload built wheels to PIP.
deps =
cibuildwheel[uv]>=2,<3
build>=1,<2
allowlist_externals =
docker
commands =
python -m build . --sdist
cibuildwheel --output-dir dist --platform auto
```
#### Upload
Shell command: ```tox -e upload```
Uploads the sdist and wheel files created by 'build' task to [PyPI](https://pypi.org/). When this task runs for the
first time, it uses automation-cli to generate a .pypirc file and store user-provided PyPI upload token into that file.
This allows reusing the token for later uploads, streamlining the process. The task is configured to skip uploading
already uploaded files to avoid errors. This is all it takes to make your project available for downloads using
'pip install.'
Example tox.ini section:
```
[testenv:upload]
description =
Uses twine to upload all files inside the '/dist' folder to pip, ignoring any files that are already uploaded.
Uses API token stored in '.pypirc' file or provided by user to authenticate the upload.
deps =
twine>=5,<6
ataraxis-automation>=3,<4
allowlist_externals =
distutils
commands =
automation-cli --verbose acquire-pypi-token {posargs:}
twine upload dist/* --skip-existing --config-file .pypirc
```
#### Recipe
Shell command: ```tox -e recipe```
This task is the *first* out of *multiple* steps to upload a project to [conda-forge](https://conda-forge.org/) channel.
Overall, this process leads to your project becoming installable with 'conda install.' The task uses automation-cli
to generate a 'recipe' folder inside the root project directory and then uses grayskull to generate the project recipe
using *the most recent pip version* of the project. This task assumes that pip contains the source-code distribution
(sdist) for the project. Since all our projects are distributed under GPL3 license, they always contain source-code
distributions. See [conda-forge documentation](https://conda-forge.org/docs/maintainer/adding_pkgs/) for more
information on uploading packages to conda-forge.
Example tox.ini section:
```
[testenv:recipe]
skip_install = true
description =
Uses grayskull to parse the source code tarball stored on pip and generate the recipe used to submit the
package to conda-forge. The submission process has to be carried out manually, see
https://conda-forge.org/docs/maintainer/adding_pkgs/ for more details.
deps =
grayskull>=2,<3
ataraxis-automation>=3,<4
commands =
automation-cli --verbose generate-recipe-folder
grayskull pypi ataraxis_automation -o recipe --strict-conda-forge --list-missing-deps -m Inkaros
```
### Conda-environment manipulation tox commands
*__Note!__* These commands were written to automate repetitive tasks associated with project-specific conda
environments. They assume that there is a validly configured conda or mamba version installed and accessible from the
shell of the machine these commands are called on. All of these tasks can be replaced with sequences of manual conda
or pip commands if necessary.
#### Install
Shell command: ```tox -e install```
Installs the project into the requested environment. This task is used to build and install the project into the
project development environment. This is a prerequisite for manually running and testing projects that are being
actively developed. During general 'tox' runtime, this task is used to (re)install the project into the
project environment as necessary to avoid collisions with 'tox.'
*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'
Example tox.ini section:
```
[testenv:install]
basepython = py310
deps =
ataraxis-automation>=3,<4
depends =
uninstall
lint
stubs
{py310, py311, py312}-test
coverage
docs
description =
Builds and installs the project into the specified conda environment. If the environment does not exist, creates
it before installing the project.
commands =
automation-cli --verbose install-project --environment-name axa_dev --python-version 3.12
```
#### Uninstall
Shell command: ```tox -e uninstall```
Removes the project from the requested environment. This task is used in-conjunction with the 'install' task to
avoid version collisions when running general 'tox' tasks.
*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'
Example tox.ini section:
```
[testenv:uninstall]
basepython = py310
deps =
ataraxis-automation>=3,<4
description =
Uninstalls the project from the specified conda environment. If the environment does not exist
this task silently succeeds.
commands =
automation-cli --verbose uninstall-project --environment-name axa_dev --python-version 3.12
```
#### Create
Shell command: ```tox -e create```
Creates the requested conda environment and installs project dependencies listed in pyproject.toml into the environment.
This task is intended to be used when setting up project development environments for new platforms and architectures.
To work as intended, it uses automation-cli to parse the contents of tox.ini and pyproject.toml files to generate a
list of project dependencies. It assumes that dependencies are stored using Sun Lab format: inside 'conda,' 'noconda,'
'condarun,' and general 'dependencies' section.
*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'
Example tox.ini section:
```
[testenv:create]
basepython = py310
deps =
ataraxis-automation>=3,<4
description =
Creates a minimally-configured conda environment using the requested python version and installs conda- and pip-
dependencies extracted from pyproject.toml file into the environment. Does not install the project!
commands =
automation-cli --verbose create-env --environment-name axa_dev --python-version 3.12
```
#### Remove
Shell command: ```tox -e remove```
Removes the project-specific conda environment. Primarily, this task is intended to be used to clean the local system
after finishing development and to hard-reset the environment (this use is discouraged!).
Example tox.ini section:
```
[testenv:remove]
basepython = py310
deps =
ataraxis-automation>=3,<4
description =
Removes the requested conda environment, if it is installed locally.
commands =
automation-cli --verbose remove-env --environment-name axa_dev
```
#### Provision
Shell command: ```tox -e provsion```
This task is a 'soft' combination of the 'remove' and 'create' tasks that allows resetting environments without deleting
them. It first uninstalls all packages in the environment and then re-installs project dependencies using pyproject.toml
file. This is the same procedure as used by the 'create' task. Since this task does not remove the environment, it
preserves all references used by tools such as IDEs, but completely resets all packages in the environment. This can
be used to both reset and actualize project development environments to match the latest version of the
.toml specification.
*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'
Example tox.ini section:
```
[testenv:provision]
basepython = py310
deps =
ataraxis-automation>=3,<4
description =
Provisions an already existing environment by uninstalling all packages from the environment and then installing the
project dependencies using pyproject.toml specifications.
commands =
automation-cli --verbose provision-env --environment-name axa_dev --python-version 3.12
```
#### Export
Shell command: ```tox -e export```
Exports the target development environment as a .yml and spec.txt files. This task is used before distributing new
versions of the project. This allows end-users to generate an identical copy of the development environment, which is
a highly encouraged feature for most projects. While our 'create' and 'provision' tasks make this largely obsolete, we
still include exported environments in all our project distributions.
Example tox.ini section:
```
[testenv:export]
deps =
ataraxis-automation>=3,<4
description =
Exports the requested conda environment to the 'envs' folder as a .yml file and as a spec.txt with revision history.
commands =
automation-cli --verbose export-env --environment-name axa_dev
```
#### Import
Shell command: ```tox -e import```
Imports the project development environment from an available '.yml' file. If the environment does not exist, this
creates an identical copy of the environment stored in the .yml file. If the environment already exists, it is instead
updated using the '.yml' file. The update process is configured to prune any 'unused' packages not found inside the
'.yml' file. This can be used to clone or actualize the project development environment from a file distributed via
'export' task.
Example tox.ini section:
```
[testenv:import]
deps =
ataraxis-automation>=3,<4
description =
Discovers and imports (installs) a new or updates an already existing environment using the .yml file
stored in the 'envs' directory.
commands =
automation-cli --verbose import-env --environment-name axa_dev
```
#### Rename
Shell command: ```tox -e rename```
Renames all environment files inside the project_root/envs directory to use the provided base_name (obtained from
user via dialog). This is used to quickly rename all environment files, which is helpful when renaming the project.
Primarily, this task is used during 'adoption' task, but it also has uses during general development. The renaming
procedure also changes the value of the 'name' field inside the '.yml' files. Environments created from renamed files
will use the 'altered' environment name.
Example tox.ini section:
```
[testenv:rename]
deps =
ataraxis-automation>=3,<4
description =
Replaces the base environment name used by all files inside the 'envs' directory with the user-input name.
commands =
automation-cli --verbose rename-environments
```
#### Adopt
Shell command: ```tox -e adopt```
This task is designed to be used on new projects initialized from one of Sun Lab templates. Templates come with
'placeholders' in most meta-files (pyproject.toml, tox.ini, etc.). This task finds and replaces the placeholders with
user-defined values (obtained via dialog). This simplifies customizing the template projects to suite the specific needs
of your particular project, while still benefiting from the Sun Lab structure and support files.
Example tox.ini section:
```
[testenv:adopt]
deps =
ataraxis-automation>=3,<4
description =
Adopts a Sun Lab template-generated project by replacing default placeholders with user-provided information.
commands =
automation-cli --verbose adopt-project
```
___
## API Documentation
See the [API documentation](https://ataraxis-automation-api-docs.netlify.app/) for the
detailed description of the methods and classes exposed by components of this library. __*Note*__ the documentation
also includes a list of all command-line interface functions provided by automation-cli script.
___
## Developers
This section provides installation, dependency, and build-system instructions for the developers that want to
modify the source code of this library. Additionally, it contains instructions for recreating the conda environments
that were used during development from the included .yml files.
### Installing the library
1. Download this repository to your local machine using your preferred method, such as git-cloning.
2. ```cd``` to the root directory of the project using your command line interface of choice.
3. Install development dependencies. You have multiple options of satisfying this requirement:
1. **_Preferred Method:_** Use conda or pip to install
[tox](https://tox.wiki/en/latest/user_guide.html) or use an environment that has it installed and
call ```tox -e import``` to automatically import the os-specific development environment included with the
source code in your local conda distribution. Alternatively, you can use ```tox -e create``` to create the
environment from scratch and automatically install the necessary dependencies using pyproject.toml file. See
[environments](#environments) section for other environment installation methods.
2. Run ```python -m pip install .'[dev]'``` command to install development dependencies and the library using
pip. On some systems, you may need to use a slightly modified version of this command:
```python -m pip install .[dev]```.
3. As long as you have an environment with [tox](https://tox.wiki/en/latest/user_guide.html) installed
and do not intend to run any code outside the predefined project automation pipelines, tox will automatically
install all required dependencies for each task.
**Note:** When using tox automation, having a local version of the library may interfere with tox tasks that attempt
to build the library using an isolated environment. While the problem is rare, our 'tox' pipelines automatically
install and uninstall the project from its' conda environment. This relies on a static tox configuration and will only
target the project-specific environment, so it is advised to always ```tox -e import``` or ```tox -e create``` the
project environment using 'tox' before running other tox commands.
### Additional Dependencies
In addition to installing the required python packages, separately install the following dependencies:
1. [Python](https://www.python.org/downloads/) distributions, one for each version that you intend to support.
Currently, this library supports version 3.10 and above. The easiest way to get tox to work as intended is to have
separate python distributions, but using [pyenv](https://github.com/pyenv/pyenv) is a good alternative too.
This is needed for the 'test' task to work as intended.
### Development Automation
This project comes with a fully configured set of automation pipelines implemented using
[tox](https://tox.wiki/en/latest/user_guide.html). Check [tox.ini file](tox.ini) for details about
available pipelines and their implementation. Alternatively, call ```tox list``` from the root directory of the project
to see the list of available tasks. __*Note*__, automation pipelines for this library list itself as a circular
dependency in some use cases. Generally, this is not an issue when patching or adding new functionality, but requires
extra care when working on major library versions.
**Note!** All commits to this library have to successfully complete the ```tox``` task before being pushed to GitHub.
To minimize the runtime task for this task, use ```tox --parallel```.
### Environments
All environments used during development are exported as .yml files and as spec.txt files to the [envs](envs) folder.
The environment snapshots were taken on each of the three explicitly supported OS families: Windows 11, OSx (M1) 14.5
and Linux Ubuntu 22.04 LTS.
**Note!** Since the OSx environment was built on an M1 (Apple Silicon) platform, it may not work on Intel-based
Apple devices.
To install the development environment for your OS:
1. Download this repository to your local machine using your preferred method, such as git-cloning.
2. ```cd``` into the [envs](envs) folder.
3. Use one of the installation methods below:
1. **_Preferred Method_**: Install [tox](https://tox.wiki/en/latest/user_guide.html) or use another
environment with already installed tox and call ```tox -e import-env```.
2. **_Alternative Method_**: Run ```conda env create -f ENVNAME.yml``` or ```mamba env create -f ENVNAME.yml```.
Replace 'ENVNAME.yml' with the name of the environment you want to install (axa_dev_osx for OSx,
axa_dev_win for Windows, and axa_dev_lin for Linux).
**Hint:** while only the platforms mentioned above were explicitly evaluated, this project is likely to work on any
common OS, but may require additional configurations steps.
Since the release of ataraxis-automation 2.0.0, you can also create the development environment from scratch
via pyproject.toml dependencies. To do this, use ```tox -e create``` from project root directory.
### Automation Troubleshooting
Many packages used in 'tox' automation pipelines (uv, mypy, ruff) and 'tox' itself are prone to various failures. In
most cases, this is related to their caching behavior. Despite a considerable effort to disable caching behavior known
to be problematic, in some cases it cannot or should not be eliminated. If you run into an unintelligible error with
any of the automation components, deleting the corresponding .cache (.tox, .ruff_cache, .mypy_cache, etc.) manually
or via a cli command is very likely to fix the issue.
___
## Versioning
We use [semantic versioning](https://semver.org/) for this project. For the versions available, see the
[tags on this repository](https://github.com/Sun-Lab-NBB/ataraxis-automation/tags).
---
## Authors
- Ivan Kondratyev ([Inkaros](https://github.com/Inkaros))
___
## License
This project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.
___
## Acknowledgments
- All Sun Lab [members](https://neuroai.github.io/sunlab/people) for providing the inspiration and comments during the
development of this library.
- [click](https://github.com/pallets/click/) project for providing the low-level command-line-interface functionality
for this project.
- [pyyaml](https://github.com/yaml/pyyaml.org), [appdirs](https://github.com/ActiveState/appdirs),
and [tomli](https://github.com/hukkin/tomli) for providing low-level functionality for some of the automation
functions.
- The teams behind [pip](https://github.com/pypa/pip), [uv](https://github.com/astral-sh/uv),
[conda](https://conda.org/), [mamba](https://github.com/mamba-org/mamba) and [tox](https://github.com/tox-dev/tox),
which form the backbone of our code distribution and management pipeline.
- The creators of all other projects listed in out [pyproject.toml](pyproject.toml) file and used in automation
pipelines across all Sun Lab projects.
Raw data
{
"_id": null,
"home_page": null,
"name": "ataraxis-automation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Ivan Kondratyev <ik278@cornell.edu>",
"keywords": "ataraxis, automation, development-tools, tox",
"author": null,
"author_email": "Ivan Kondratyev <ik278@cornell.edu>",
"download_url": "https://files.pythonhosted.org/packages/58/bb/58f186c34dbd40d733b6fa3913990af7e6ea7b7eaff329f82f3fdcd6779b/ataraxis_automation-3.0.4.tar.gz",
"platform": null,
"description": "# ataraxis-automation\n\nA Python library that provides scripts that support tox-based development automation pipelines used by other \nSun Lab projects.\n\n\n\n[](https://github.com/astral-sh/uv)\n[](https://github.com/astral-sh/ruff)\n\n\n\n\n___\n\n## Detailed Description\n\nThis library is one of the two 'base' dependency libraries used by every other Sun Lab project (the other being \n[ataraxis-base-utilities](https://github.com/Sun-Lab-NBB/ataraxis-base-utilities)). It exposes a command-line interface\n(automation-cli) that can be used through the [tox-based](https://tox.wiki/en/latest/user_guide.html) project\ndevelopment automation suite that comes with every Sun Lab project (we use tox as an analog to build system).\n\nThe commands from this library generally fulfill two major roles. First, they are used to set up, support, \nor clean up after third-party packages (ruff, mypy, stubgen, grayskull, etc.) used by our tox tasks. Second, they \nautomate most operations with conda environments, such as creating / removing the environment and \ninstalling / uninstalling the project from the environment.\n\nThe library can be used as a standalone module, but it is primarily designed to integrate with other Sun Lab projects,\nproviding development automation functionality. Therefore, it may require either adopting and modifying a \ntox automation suite from one of the lab projects or significant refactoring to work with non-lab projects.\n___\n\n## Features\n\n- Supports Windows, Linux, and OSx.\n- Optimized for runtime speed by preferentially using mamba and uv over conda and pip.\n- Compliments the extensive suite of tox-automation tasks used by all Sun Lab projects.\n- Pure-python API.\n- GPL 3 License.\n\n___\n\n## Table of Contents\n\n- [Dependencies](#dependencies)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Documentation](#api-documentation)\n- [Developers](#developers)\n- [Versioning](#versioning)\n- [Authors](#authors)\n- [License](#license)\n- [Acknowledgements](#Acknowledgments)\n\n___\n\n## Dependencies\n\nFor users, all library dependencies are installed automatically for all supported installation methods\n(see [Installation](#installation) section). For developers, see the [Developers](#developers) section for\ninformation on installing additional development dependencies.\n___\n\n## Installation\n\n### Source\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning. Optionally, use one\n of the stable releases that include precompiled binary wheels in addition to source code.\n2. ```cd``` to the root directory of the project using your command line interface of choice.\n3. Run ```python -m pip install .``` to install the project. Alternatively, if using a distribution with precompiled\n binaries, use ```python -m pip install WHEEL_PATH```, replacing 'WHEEL_PATH' with the path to the wheel file.\n\n### PIP\n\nUse the following command to install the library using PIP: ```pip install ataraxis-automation```\n\n### Conda / Mamba\n\n**_Note. Due to conda-forge contributing process being more nuanced than pip uploads, conda versions may lag behind\npip and source code distributions._**\n\nUse the following command to install the library using Conda or Mamba: ```conda install ataraxis-automation```\n___\n\n## Usage\n\n### Quickstart\nThe easiest way to get Sun Lab automation to work for your project is to initialize the project using one of our \ntemplates for \n[pure-python](https://github.com/Sun-Lab-NBB/pure-python-template) or \n[c-extension](https://github.com/Sun-Lab-NBB/c-python-template) projects. To initialize and customize one of our \ntemplates, follow these steps:\n1. Navigate to the desired template via one of the links above and click ```Use this template``` button in the \n top right corner of the page.\n2. Initialize your project as necessary and download and unpack it on your local machine. To do this, you can use tools\n such as git-cloning.\n3. ```cd``` into the root directory of the project.\n4. Use the ```tox -e adopt``` command to 'adopt' the project. The adoption process replaces placeholder markers in the\n template 'meta' files with information appropriate for your project.\n5. Add your source code and support files as needed.\n\n### Automation Command-Line Interface\nAll library functions designed to be called by end-users are exposed through the 'automation-cli' script.\nThis cli script is automatically exposed after installing the library into a conda or virtual environment.\n\n#### Automation-CLI\nWhile the preferred use case for this library is via 'tox' tasks, you can access all functions supplied by the library\nby calling ```automation-cli``` from the shell that has access to the python environment with the library. Here are \nsome examples of how you can use the automation-cli directly:\n- Use ```automation-cli --help``` to verify that the cli is available and to see the list of supported commands.\n- Use ```automation-cli COMMAND-NAME --help``` to display additional information about a specific command. For example:\n ```automation-cli import-env --help```.\n\n#### Tox automation\nThis library is intended to be used to augment 'tox' runtimes, and this is always the preferred use case.\nTo use any of the commands as part of a tox 'task,' add it to the 'commands' section of the tox.ini:\n```\n[testenv:create]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Creates a minimally-configured conda environment using the requested python version and installs conda- and pip-\n dependencies extracted from pyproject.toml file into the environment. Does not install the project!\ncommands =\n automation-cli --verbose create-env --environment-name axa_dev --python-version 3.12\n```\n#### Logging and Printing\nAll cli commands come with two parameters exposed through the main cli group:\n1. ```--verbose```: Determines whether to display Information, Warning and Success messages to inform the user about\n the ongoing runtime.\n2. ```--log```: Determines whether to save messages and errors to log files (located in automatically generated folder\n inside user log directory).\n\n#### Command-specific flags\n*__Note!__* Many sub-commands of the cli have additional flags and arguments that can be used to further customize\ntheir runtime. Consult the API documentation to see these options with detailed descriptions.\n\n*__Warning!__* When using any cli command that uses ```--python-version``` flag from tox, you __have__ to include \n```basepython=``` line in the environment configuration __and__ set it to a python version __different__ from the \none provided after ```--python-version``` argument. See the 'testenv:create' example above.\n\n### Intended cli use pattern\nAll cli commands are intended to be used through tox pipelines. The most recent version of Sun Lab tox configuration\nis always available from this libraries' [tox.ini file](tox.ini). Since this library plays a large role in our tox \nautomation pipelines, its tox configuration is always the most up to date and feature-packed compared to all other \nSun Lab projects.\n\nAny well-maintained Sun Lab project comes with an up-to-date tox configuration that automates most 'meta' \ndevelopment steps, such as code formatting, project testing, and project distribution. By automating most of these \nsteps, we seek to provide clear standards to be shared by internal and external collaborators. Additionally, this \nallows developers to focus on the important task of planning and writing the code of their projects over 'meta' tasks\nlike code formatting.\n\n### Available 'tox' commands\nThis library is tightly linked to our 'tox' configuration. Most of our 'tox' tasks either use some functions from this \nlibrary in addition to external packages or entirely consist of calling functions from this library. Therefore, this\ndocumentation would not have been complete without having a section about our 'tox' tasks, in addition to the basic\ninformation about our 'automation-cli' script.\n\nNote that commands listed here may and frequently are modified based on the specific needs of each project that \nuses them. Therefore, this section is *__not__* a replacement for studying the tox.ini file for the specific project you\nseek to develop. Additionally, using tasks listed here 'as is' may not work for your project without customizations.\n\nMost of the commands in this section are designed to be executed together (some sequentially, some in-parallel) when\na general ```tox``` command is used. These are considered 'checkout' tasks, and they generally cover the things that \nneed to be present for a commit to be pushed to the main branch of any Sun Lab project.\n\n#### Lint\nShell command: ```tox -e lint```\n\nUses [ruff](https://github.com/astral-sh/ruff) and [mypy](https://github.com/python/mypy) to statically analyze and, \nwhere possible, fix code formatting, typing, and problematic use patterns. This helps to ensure the code is \nformatted according to our standards and does not contain easily identifiable problematic use patterns, such as \ntype violations. As part of its runtime, this task uses automation cli to remove existing stub (.pyi) files from \nthe source folders, as they interfere with type-checking.\n\nExample tox.ini section:\n```\n[testenv: lint]\ndescription =\n Runs static code formatting, style and typing checkers. Mypy may not work properly until py.typed marker is\n added by 'stubs' task.\ndeps =\n mypy>=1,<2\n ruff>=0,<1\n types-pyyaml>=6,<7\n ataraxis-automation>=3,<4\ndepends = uninstall\n# Note! Basepython has to be set to the 'lowest' version supported by your project\nbasepython = py310\ncommands =\n automation-cli --verbose purge-stubs\n ruff check --select I --fix\n ruff format\n mypy . --strict --extra-checks --warn-redundant-cast\n```\n\n#### Stubs\nShell command: ```tox -e stubs```\n\nUses [stubgen](https://mypy.readthedocs.io/en/stable/stubgen.html) to generate stub (.pyi) files and, \nvia automation-cli, distribute them to the appropriate levels of the library source folder. This is necessary to \nsupport static type-checking for projects that use your project. As part of that process, automation-cli also ensures \nthat there is a 'py.typed' marker file in the highest library directory. This is required for type-checkers like mypy \nto recognize the project as 'typed' and process it during type-checking tasks.\n\nExample tox.ini section:\n```\n[testenv: stubs]\ndescription =\n Generates the py.typed marker and the stub files using the built library wheel. Formats the stubs with ruff before\n moving them to appropriate source sub-directories.\ndeps =\n mypy>=1,<2\n ruff>=0,<1\n ataraxis-automation>=3,<4\ndepends = lint\ncommands =\n automation-cli --verbose process-typed-markers\n stubgen -o stubs --include-private --include-docstrings -p ataraxis_automation -v\n ruff check --select I --fix\n ruff format\n automation-cli --verbose process-stubs\n```\n\n#### Test\nShell command: ```tox -e pyXXX-test``` \n\nThis task is available for all python versions supported by each project. For example, automation supports versions \n3.10, 3.11, and 3.12. Therefore, it will have ```tox -e py310-test```, ```tox -e py311-test``` and \n```tox -e py312-test``` as valid 'test' tasks. These tasks are used to build the project in an isolated environment and \nrun the tests expected to be located inside the project_root/tests directory to verify the project works as expected \nfor each python version. This is especially relevant for c-extension projects that compile code for specific python \nversions and platforms.\n\nExample tox.ini section:\n```\n[testenv: {py310, py311, py312}-test]\npackage = wheel\ndescription =\n Runs unit and integration tests for each of the python versions listed in the task name. Uses 'loadgroup' balancing\n and all logical cores to optimize runtime speed while allowing manual control over which cores execute tasks (see\n pytest-xdist documentation).\ndeps =\n pytest>=8,<9\n pytest-cov>=5,<6\n pytest-xdist>=3,<4\n coverage[toml]>=7,<8\ndepends = uninstall\nsetenv =\n # Sets environment parameters, which includes intermediate coverage aggregation file used by coverage.\n COVERAGE_FILE = reports{/}.coverage.{envname}\ncommands =\n # Make sure the --cov is always set to the intended library name, so that coverage runs on the whole library\n # exactly once.\n pytest --import-mode=append --cov=ataraxis_automation --cov-config=pyproject.toml --cov-report=xml \\\n --junitxml=reports/pytest.xml.{envname} -n logical --dist loadgroup\n```\n\n#### Coverage\nShell command: ```tox -e coverage``` \n\nThis task is designed to be used in-conjunction with the 'test' task. It aggregates code coverage data for different \npython versions and compiles it into a html-report accessible by opening project_root/reports/coverage_html/index.html \nin a browser. For all lab projects, we try to provide as close to 100% code coverage as possible for each project.\n\nExample tox.ini section:\n```\n[testenv:coverage]\nskip_install = true\ndescription =\n Combines test-coverage data from multiple test runs (for different python versions) into a single html file. The\n file can be viewed by loading the 'reports/coverage_html/index.html'.\nsetenv = COVERAGE_FILE = reports/.coverage\ndepends = {py310, py311, py312}-test\ndeps =\n junitparser>=3,<4\n coverage[toml]>=7,<8\ncommands =\n junitparser merge --glob reports/pytest.xml.* reports/pytest.xml\n coverage combine --keep\n coverage xml\n coverage html\n```\n#### Doxygen\nShell command: ```tox -e doxygen```\n\n*__Note!__* This task is only used in c-extension projects.\n\nThis task is unique to our c-extension projects (projects that contain compiled c / c++ code). It uses \n[Doxygen](https://www.doxygen.nl/) to parse doxygen-styled docstrings used in our c-code to make them accessible to \n[Sphinx](https://www.sphinx-doc.org/en/master/) (used as part of our 'docs' task). This allows automatically building\nC/C++ API documentation and organically bundling it with Python API documentation via sphinx.\n\nExample tox.ini section:\n```\n[testenv:doxygen]\nskip_install = true\ndescription =\n Generates C++ / C source code documentation using Doxygen. This assumes the source code uses doxygen-compatible\n docstrings and that the root directory contains a Doxyfile that minimally configures Doxygen runtime.\nallowlist_externals = doxygen\ndepends = uninstall\ncommands =\n doxygen Doxyfile\n```\n\n#### Docs\nShell command: ```tox -e docs```\n\nUses [sphinx](https://www.sphinx-doc.org/en/master/) to automatically parse docstrings from source code and use them \nto build API documentation for the project. C-extension projects use a slightly modified version of this task that uses\n[breathe](https://breathe.readthedocs.io/en/latest/) to convert doxygen-generated xml files for c-code into a format \nthat sphinx can parse. This way, c-extension projects can include both Python and C/C++ API documentation as part of \nthe same file. This task relies on the configuration files stored inside /project_root/docs/source folder to define \nthe generated documentation format. Built documentation can be viewed by opening \nproject_root/docs/build/html/index.html in a browser.\n\nExample tox.ini section for a pure-python project:\n```\n[testenv:docs]\ndescription =\n Builds the API documentation from source code docstrings using Sphinx. The result can be viewed by loading\n 'docs/build/html/index.html'.\ndepends = uninstall\ndeps =\n sphinx>=7,<8\n importlib_metadata>=8,<9\n sphinx-rtd-theme>=2,<3\n sphinx-click>=6,<7\n sphinx-autodoc-typehints>=2,<3\ncommands =\n sphinx-build -b html -d docs/build/doctrees docs/source docs/build/html -j auto -v\n```\n\nExample tox.ini section for a c-extension project:\n```\n[testenv:docs]\ndescription =\n Builds the API documentation from source code docstrings using Sphinx. Integrates with C / C++ documentation via\n Breathe, provided that Doxygen was used to generate the initial .xml file for C-extension sources. The result can\n be viewed by loading 'docs/build/html/index.html'.\ndepends = doxygen\ndeps =\n sphinx>=7,<8\n importlib_metadata>=8,<9\n sphinx-rtd-theme>=2,<3\n sphinx-click>=6,<7\n sphinx-autodoc-typehints>=2,<3\n breathe>=4,<5\ncommands =\n sphinx-build -b html -d docs/build/doctrees docs/source docs/build/html -j auto -v\n```\n\n#### Build\nShell command: ```tox -e build```\n\nThis task differs for c-extension and pure-python projects. In both cases, it builds a source-code distribution (sdist)\nand a binary distribution (wheel) for the project. These distributions can then be uploaded to GitHub, PyPI, and Conda \nfor further distribution or shared with other people manually. Pure Python projects use \n[hatchling](https://hatch.pypa.io/latest/) and [build](https://build.pypa.io/en/stable/) to generate\none source-code and one binary distribution. C-extension projects use \n[cibuildwheel](https://cibuildwheel.pypa.io/en/stable/) to compile c-code for all supported platforms and \narchitectures, building many binary distribution files alongside source-code distribution generated via build.\n\nExample tox.ini section for a pure-python project:\n```\n[testenv:build]\nskip-install = true\ndescription =\n Builds the source code distribution (sdist) and the binary distribution package (wheel). Use 'upload' task to\n subsequently upload built wheels to PIP.\ndeps =\n build>=1,<2\n hatchling>=1,<2\nallowlist_externals =\n docker\ncommands =\n python -m build . --sdist\n python -m build . --wheel\n```\n\nExample tox.ini section for a c-extension project:\n```\n[testenv:build]\nskip-install = true\ndescription =\n Builds the source code distribution (sdist) and compiles and assembles binary wheels for all architectures of the\n host-platform supported by the library. Use 'upload' task to subsequently upload built wheels to PIP.\ndeps =\n cibuildwheel[uv]>=2,<3\n build>=1,<2\nallowlist_externals =\n docker\ncommands =\n python -m build . --sdist\n cibuildwheel --output-dir dist --platform auto\n```\n\n#### Upload\nShell command: ```tox -e upload```\n\nUploads the sdist and wheel files created by 'build' task to [PyPI](https://pypi.org/). When this task runs for the \nfirst time, it uses automation-cli to generate a .pypirc file and store user-provided PyPI upload token into that file.\nThis allows reusing the token for later uploads, streamlining the process. The task is configured to skip uploading\nalready uploaded files to avoid errors. This is all it takes to make your project available for downloads using \n'pip install.'\n\nExample tox.ini section:\n```\n[testenv:upload]\ndescription =\n Uses twine to upload all files inside the '/dist' folder to pip, ignoring any files that are already uploaded.\n Uses API token stored in '.pypirc' file or provided by user to authenticate the upload.\ndeps =\n twine>=5,<6\n ataraxis-automation>=3,<4\nallowlist_externals =\n distutils\ncommands =\n automation-cli --verbose acquire-pypi-token {posargs:}\n twine upload dist/* --skip-existing --config-file .pypirc\n```\n\n#### Recipe\nShell command: ```tox -e recipe```\n\nThis task is the *first* out of *multiple* steps to upload a project to [conda-forge](https://conda-forge.org/) channel.\nOverall, this process leads to your project becoming installable with 'conda install.' The task uses automation-cli \nto generate a 'recipe' folder inside the root project directory and then uses grayskull to generate the project recipe\nusing *the most recent pip version* of the project. This task assumes that pip contains the source-code distribution\n(sdist) for the project. Since all our projects are distributed under GPL3 license, they always contain source-code \ndistributions. See [conda-forge documentation](https://conda-forge.org/docs/maintainer/adding_pkgs/) for more \ninformation on uploading packages to conda-forge.\n\nExample tox.ini section:\n```\n[testenv:recipe]\nskip_install = true\ndescription =\n Uses grayskull to parse the source code tarball stored on pip and generate the recipe used to submit the\n package to conda-forge. The submission process has to be carried out manually, see\n https://conda-forge.org/docs/maintainer/adding_pkgs/ for more details.\ndeps =\n grayskull>=2,<3\n ataraxis-automation>=3,<4\ncommands =\n automation-cli --verbose generate-recipe-folder\n grayskull pypi ataraxis_automation -o recipe --strict-conda-forge --list-missing-deps -m Inkaros\n```\n\n### Conda-environment manipulation tox commands\n*__Note!__* These commands were written to automate repetitive tasks associated with project-specific conda \nenvironments. They assume that there is a validly configured conda or mamba version installed and accessible from the\nshell of the machine these commands are called on. All of these tasks can be replaced with sequences of manual conda\nor pip commands if necessary.\n\n\n#### Install\nShell command: ```tox -e install```\n\nInstalls the project into the requested environment. This task is used to build and install the project into the \nproject development environment. This is a prerequisite for manually running and testing projects that are being \nactively developed. During general 'tox' runtime, this task is used to (re)install the project into the\nproject environment as necessary to avoid collisions with 'tox.'\n\n*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'\n\nExample tox.ini section:\n```\n[testenv:install]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndepends =\n uninstall\n lint\n stubs\n {py310, py311, py312}-test\n coverage\n docs\ndescription =\n Builds and installs the project into the specified conda environment. If the environment does not exist, creates\n it before installing the project.\ncommands =\n automation-cli --verbose install-project --environment-name axa_dev --python-version 3.12\n```\n\n#### Uninstall\nShell command: ```tox -e uninstall```\n\nRemoves the project from the requested environment. This task is used in-conjunction with the 'install' task to \navoid version collisions when running general 'tox' tasks.\n\n*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'\n\nExample tox.ini section:\n```\n[testenv:uninstall]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Uninstalls the project from the specified conda environment. If the environment does not exist\n this task silently succeeds.\ncommands =\n automation-cli --verbose uninstall-project --environment-name axa_dev --python-version 3.12\n```\n\n#### Create\nShell command: ```tox -e create```\n\nCreates the requested conda environment and installs project dependencies listed in pyproject.toml into the environment.\nThis task is intended to be used when setting up project development environments for new platforms and architectures. \nTo work as intended, it uses automation-cli to parse the contents of tox.ini and pyproject.toml files to generate a \nlist of project dependencies. It assumes that dependencies are stored using Sun Lab format: inside 'conda,' 'noconda,'\n'condarun,' and general 'dependencies' section.\n\n*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'\n\nExample tox.ini section:\n```\n[testenv:create]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Creates a minimally-configured conda environment using the requested python version and installs conda- and pip-\n dependencies extracted from pyproject.toml file into the environment. Does not install the project!\ncommands =\n automation-cli --verbose create-env --environment-name axa_dev --python-version 3.12\n```\n\n#### Remove\nShell command: ```tox -e remove```\n\nRemoves the project-specific conda environment. Primarily, this task is intended to be used to clean the local system \nafter finishing development and to hard-reset the environment (this use is discouraged!).\n\nExample tox.ini section:\n```\n[testenv:remove]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Removes the requested conda environment, if it is installed locally.\ncommands =\n automation-cli --verbose remove-env --environment-name axa_dev\n```\n\n#### Provision\nShell command: ```tox -e provsion```\n\nThis task is a 'soft' combination of the 'remove' and 'create' tasks that allows resetting environments without deleting\nthem. It first uninstalls all packages in the environment and then re-installs project dependencies using pyproject.toml\nfile. This is the same procedure as used by the 'create' task. Since this task does not remove the environment, it \npreserves all references used by tools such as IDEs, but completely resets all packages in the environment. This can\nbe used to both reset and actualize project development environments to match the latest version of the \n.toml specification.\n\n*__Note!__* The 'basepython' argument should always be set to a version different from '--python-version.'\n\nExample tox.ini section:\n```\n[testenv:provision]\nbasepython = py310\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Provisions an already existing environment by uninstalling all packages from the environment and then installing the\n project dependencies using pyproject.toml specifications.\ncommands =\n automation-cli --verbose provision-env --environment-name axa_dev --python-version 3.12\n```\n\n#### Export\nShell command: ```tox -e export```\n\nExports the target development environment as a .yml and spec.txt files. This task is used before distributing new \nversions of the project. This allows end-users to generate an identical copy of the development environment, which is \na highly encouraged feature for most projects. While our 'create' and 'provision' tasks make this largely obsolete, we \nstill include exported environments in all our project distributions.\n\nExample tox.ini section:\n```\n[testenv:export]\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Exports the requested conda environment to the 'envs' folder as a .yml file and as a spec.txt with revision history.\ncommands =\n automation-cli --verbose export-env --environment-name axa_dev\n```\n\n#### Import\nShell command: ```tox -e import```\n\nImports the project development environment from an available '.yml' file. If the environment does not exist, this \ncreates an identical copy of the environment stored in the .yml file. If the environment already exists, it is instead\nupdated using the '.yml' file. The update process is configured to prune any 'unused' packages not found inside the \n'.yml' file. This can be used to clone or actualize the project development environment from a file distributed via\n'export' task.\n\nExample tox.ini section:\n```\n[testenv:import]\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Discovers and imports (installs) a new or updates an already existing environment using the .yml file\n stored in the 'envs' directory.\ncommands =\n automation-cli --verbose import-env --environment-name axa_dev\n```\n\n#### Rename\nShell command: ```tox -e rename```\n\nRenames all environment files inside the project_root/envs directory to use the provided base_name (obtained from \nuser via dialog). This is used to quickly rename all environment files, which is helpful when renaming the project. \nPrimarily, this task is used during 'adoption' task, but it also has uses during general development. The renaming \nprocedure also changes the value of the 'name' field inside the '.yml' files. Environments created from renamed files\nwill use the 'altered' environment name.\n\nExample tox.ini section:\n```\n[testenv:rename]\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Replaces the base environment name used by all files inside the 'envs' directory with the user-input name.\ncommands =\n automation-cli --verbose rename-environments\n```\n\n#### Adopt\nShell command: ```tox -e adopt```\n\nThis task is designed to be used on new projects initialized from one of Sun Lab templates. Templates come with \n'placeholders' in most meta-files (pyproject.toml, tox.ini, etc.). This task finds and replaces the placeholders with\nuser-defined values (obtained via dialog). This simplifies customizing the template projects to suite the specific needs\nof your particular project, while still benefiting from the Sun Lab structure and support files.\n\nExample tox.ini section:\n```\n[testenv:adopt]\ndeps =\n ataraxis-automation>=3,<4\ndescription =\n Adopts a Sun Lab template-generated project by replacing default placeholders with user-provided information.\ncommands =\n automation-cli --verbose adopt-project\n```\n___\n\n## API Documentation\n\nSee the [API documentation](https://ataraxis-automation-api-docs.netlify.app/) for the\ndetailed description of the methods and classes exposed by components of this library. __*Note*__ the documentation\nalso includes a list of all command-line interface functions provided by automation-cli script.\n___\n\n## Developers\n\nThis section provides installation, dependency, and build-system instructions for the developers that want to\nmodify the source code of this library. Additionally, it contains instructions for recreating the conda environments\nthat were used during development from the included .yml files.\n\n### Installing the library\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning.\n2. ```cd``` to the root directory of the project using your command line interface of choice.\n3. Install development dependencies. You have multiple options of satisfying this requirement:\n 1. **_Preferred Method:_** Use conda or pip to install\n [tox](https://tox.wiki/en/latest/user_guide.html) or use an environment that has it installed and\n call ```tox -e import``` to automatically import the os-specific development environment included with the\n source code in your local conda distribution. Alternatively, you can use ```tox -e create``` to create the \n environment from scratch and automatically install the necessary dependencies using pyproject.toml file. See\n [environments](#environments) section for other environment installation methods.\n 2. Run ```python -m pip install .'[dev]'``` command to install development dependencies and the library using \n pip. On some systems, you may need to use a slightly modified version of this command: \n ```python -m pip install .[dev]```.\n 3. As long as you have an environment with [tox](https://tox.wiki/en/latest/user_guide.html) installed\n and do not intend to run any code outside the predefined project automation pipelines, tox will automatically\n install all required dependencies for each task.\n\n**Note:** When using tox automation, having a local version of the library may interfere with tox tasks that attempt\nto build the library using an isolated environment. While the problem is rare, our 'tox' pipelines automatically \ninstall and uninstall the project from its' conda environment. This relies on a static tox configuration and will only \ntarget the project-specific environment, so it is advised to always ```tox -e import``` or ```tox -e create``` the \nproject environment using 'tox' before running other tox commands.\n\n### Additional Dependencies\n\nIn addition to installing the required python packages, separately install the following dependencies:\n\n1. [Python](https://www.python.org/downloads/) distributions, one for each version that you intend to support. \n Currently, this library supports version 3.10 and above. The easiest way to get tox to work as intended is to have \n separate python distributions, but using [pyenv](https://github.com/pyenv/pyenv) is a good alternative too. \n This is needed for the 'test' task to work as intended.\n\n\n### Development Automation\n\nThis project comes with a fully configured set of automation pipelines implemented using \n[tox](https://tox.wiki/en/latest/user_guide.html). Check [tox.ini file](tox.ini) for details about \navailable pipelines and their implementation. Alternatively, call ```tox list``` from the root directory of the project\nto see the list of available tasks. __*Note*__, automation pipelines for this library list itself as a circular\ndependency in some use cases. Generally, this is not an issue when patching or adding new functionality, but requires\nextra care when working on major library versions.\n\n**Note!** All commits to this library have to successfully complete the ```tox``` task before being pushed to GitHub. \nTo minimize the runtime task for this task, use ```tox --parallel```.\n\n### Environments\n\nAll environments used during development are exported as .yml files and as spec.txt files to the [envs](envs) folder.\nThe environment snapshots were taken on each of the three explicitly supported OS families: Windows 11, OSx (M1) 14.5\nand Linux Ubuntu 22.04 LTS.\n\n**Note!** Since the OSx environment was built on an M1 (Apple Silicon) platform, it may not work on Intel-based \nApple devices.\n\nTo install the development environment for your OS:\n\n1. Download this repository to your local machine using your preferred method, such as git-cloning.\n2. ```cd``` into the [envs](envs) folder.\n3. Use one of the installation methods below:\n 1. **_Preferred Method_**: Install [tox](https://tox.wiki/en/latest/user_guide.html) or use another\n environment with already installed tox and call ```tox -e import-env```.\n 2. **_Alternative Method_**: Run ```conda env create -f ENVNAME.yml``` or ```mamba env create -f ENVNAME.yml```.\n Replace 'ENVNAME.yml' with the name of the environment you want to install (axa_dev_osx for OSx,\n axa_dev_win for Windows, and axa_dev_lin for Linux).\n\n**Hint:** while only the platforms mentioned above were explicitly evaluated, this project is likely to work on any \ncommon OS, but may require additional configurations steps.\n\nSince the release of ataraxis-automation 2.0.0, you can also create the development environment from scratch \nvia pyproject.toml dependencies. To do this, use ```tox -e create``` from project root directory.\n\n### Automation Troubleshooting\n\nMany packages used in 'tox' automation pipelines (uv, mypy, ruff) and 'tox' itself are prone to various failures. In \nmost cases, this is related to their caching behavior. Despite a considerable effort to disable caching behavior known \nto be problematic, in some cases it cannot or should not be eliminated. If you run into an unintelligible error with \nany of the automation components, deleting the corresponding .cache (.tox, .ruff_cache, .mypy_cache, etc.) manually \nor via a cli command is very likely to fix the issue.\n___\n\n## Versioning\n\nWe use [semantic versioning](https://semver.org/) for this project. For the versions available, see the \n[tags on this repository](https://github.com/Sun-Lab-NBB/ataraxis-automation/tags).\n\n---\n\n## Authors\n\n- Ivan Kondratyev ([Inkaros](https://github.com/Inkaros))\n\n___\n\n## License\n\nThis project is licensed under the GPL3 License: see the [LICENSE](LICENSE) file for details.\n___\n\n## Acknowledgments\n\n- All Sun Lab [members](https://neuroai.github.io/sunlab/people) for providing the inspiration and comments during the\n development of this library.\n- [click](https://github.com/pallets/click/) project for providing the low-level command-line-interface functionality \n for this project.\n- [pyyaml](https://github.com/yaml/pyyaml.org), [appdirs](https://github.com/ActiveState/appdirs), \n and [tomli](https://github.com/hukkin/tomli) for providing low-level functionality for some of the automation \n functions.\n- The teams behind [pip](https://github.com/pypa/pip), [uv](https://github.com/astral-sh/uv), \n [conda](https://conda.org/), [mamba](https://github.com/mamba-org/mamba) and [tox](https://github.com/tox-dev/tox), \n which form the backbone of our code distribution and management pipeline.\n- The creators of all other projects listed in out [pyproject.toml](pyproject.toml) file and used in automation \n pipelines across all Sun Lab projects.\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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: <program> Copyright (C) <year> <name of author> 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 <https://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 <https://www.gnu.org/licenses/why-not-lgpl.html>.",
"summary": "Provides scripts that support tox-based development automation pipelines used by other Sun Lab projects.",
"version": "3.0.4",
"project_urls": {
"Documentation": "https://ataraxis-automation-api-docs.netlify.app/",
"Homepage": "https://github.com/Sun-Lab-NBB/ataraxis-automation"
},
"split_keywords": [
"ataraxis",
" automation",
" development-tools",
" tox"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "beb462cf5153fcfe4fb9d6f0132e71d3004ed6d547a51a2c69799de847c90aed",
"md5": "6967c37d79d7dc2dc8e8dfc3245a94af",
"sha256": "1032dc12506293ecb80ac0ab327e493f44a81e6437d2e9c2d28e4dc3a98d01f0"
},
"downloads": -1,
"filename": "ataraxis_automation-3.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6967c37d79d7dc2dc8e8dfc3245a94af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 68642,
"upload_time": "2024-07-22T01:41:09",
"upload_time_iso_8601": "2024-07-22T01:41:09.180065Z",
"url": "https://files.pythonhosted.org/packages/be/b4/62cf5153fcfe4fb9d6f0132e71d3004ed6d547a51a2c69799de847c90aed/ataraxis_automation-3.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58bb58f186c34dbd40d733b6fa3913990af7e6ea7b7eaff329f82f3fdcd6779b",
"md5": "11252ccd02010cbde6821d214dfb10d8",
"sha256": "a3e149a465781cef69f24ac9af213c6e6a46648ce7f1be23a8e182cf33390c32"
},
"downloads": -1,
"filename": "ataraxis_automation-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "11252ccd02010cbde6821d214dfb10d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 100696,
"upload_time": "2024-07-22T01:41:10",
"upload_time_iso_8601": "2024-07-22T01:41:10.854762Z",
"url": "https://files.pythonhosted.org/packages/58/bb/58f186c34dbd40d733b6fa3913990af7e6ea7b7eaff329f82f3fdcd6779b/ataraxis_automation-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 01:41:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sun-Lab-NBB",
"github_project": "ataraxis-automation",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "ataraxis-automation"
}
