diff options
Diffstat (limited to 'python-annexremote.spec')
| -rw-r--r-- | python-annexremote.spec | 527 |
1 files changed, 527 insertions, 0 deletions
diff --git a/python-annexremote.spec b/python-annexremote.spec new file mode 100644 index 0000000..b553e37 --- /dev/null +++ b/python-annexremote.spec @@ -0,0 +1,527 @@ +%global _empty_manifest_terminate_build 0 +Name: python-annexremote +Version: 1.6.0 +Release: 1 +Summary: git annex special remotes made easy +License: GPLv3 +URL: https://github.com/Lykos153/AnnexRemote +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/3c/54/0b7636ee290fb7e4d03529e1c22326b226f04d67f0f3e9649cbc5177d315/annexremote-1.6.0.tar.gz +BuildArch: noarch + +Requires: python3-coverage +Requires: python3-nose + +%description +# AnnexRemote +Helper module to easily develop special remotes for [git annex](https://git-annex.branchable.com). +AnnexRemote handles all the protocol stuff for you, so you can focus on the remote itself. +It implements the complete [external special remote protocol](https://git-annex.branchable.com/design/external_special_remote_protocol) +and fulfils all specifications regarding whitespaces etc. This is ensured by an excessive test suite. +Extensions to the protocol are normally added within hours after they've been published. + +[Documentation](https://lykos153.github.io/AnnexRemote/annexremote/) + +(Also have a look at the [examples](examples) and [git-annex-remote-googledrive](https://github.com/Lykos153/git-annex-remote-googledrive) which is based on AnnexRemote.) + +## Getting started +### Prerequisites +You need python3 installed on your system. + +### Installing +`pip3 install annexremote` + +### Running the tests +If you want to run the tests, copy the content of the `tests` folder to the same location as `annexremote.py`. +Then use a test discovery like [nose](http://nose.readthedocs.io) to run them. + +### Usage + +Import the necessary classes + +``` +from annexremote import Master +from annexremote import SpecialRemote +from annexremote import RemoteError +``` + +Now create your special remote class. It must subtype ``SpecialRemote`` and implement at least the 6 basic methods: + +``` +class MyRemote(SpecialRemote): + def initremote(self): + # initialize the remote, eg. create the folders + # raise RemoteError if the remote couldn't be initialized + + def prepare(self): + # prepare to be used, eg. open TCP connection, authenticate with the server etc. + # raise RemoteError if not ready to use + + def transfer_store(self, key, filename): + # store the file in `filename` to a unique location derived from `key` + # raise RemoteError if the file couldn't be stored + + def transfer_retrieve(self, key, filename): + # get the file identified by `key` and store it to `filename` + # raise RemoteError if the file couldn't be retrieved + + def checkpresent(self, key): + # return True if the key is present in the remote + # return False if the key is not present + # raise RemoteError if the presence of the key couldn't be determined, eg. in case of connection error + + def remove(self, key): + # remove the key from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error +``` + +In your ``main`` function, link your remote to the master class and initialize the protocol: + +``` +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + master.Listen() + +if __name__ == "__main__": + main() +``` + +Now save your program as ``git-annex-remote-$something`` and make it executable. + +``chmod +x git-annex-remote-$something`` +(You'll need the sheebang line ``#!/usr/bin/env python3``) + +That's it. Now you've created your special remote. + +#### Export remotes +Import and subtype `ExportRemote` instead of `SpecialRemote`: + +``` +# ... +from annexremote import ExportRemote + +class MyRemote(ExportRemote): + # implement the remote methods just like in the above example and then additionally: + + def transferexport_store(self, key, local_file, remote_file): + # store the file located at `local_file` to `remote_file` on the remote + # raise RemoteError if the file couldn't be stored + + def transferexport_retrieve(self, key, local_file, remote_file): + # get the file located at `remote_file` from the remote and store it to `local_file` + # raise RemoteError if the file couldn't be retrieved + + def checkpresentexport(self, key, remote_file): + # return True if the file `remote_file` is present in the remote + # return False if not + # raise RemoteError if the presence of the file couldn't be determined, eg. in case of connection error + + def removeexport(self, key, remote_file): + # remove the file in `remote_file` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error + + def removeexportdirectory(self, remote_directory): + # remove the directory `remote_directory` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing directory isn't considered an error + + def renameexport(self, key, filename, new_filename): + # move the remote file in `name` to `new_name` + # raise RemoteError if it couldn't be moved + +``` + +#### Logging +This module includes a StreamHandler to send log records to git annex via the special remote protocol (using DEBUG). You can use it like this: + +``` +... +import logging +... + +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + + logger = logging.getLogger() + logger.addHandler(master.LoggingHandler()) + + master.Listen() + +if __name__ == "__main__": + main() +``` + + +## License + +This project is licensed under GPLv3 - see the [LICENSE](LICENSE) file for details + + + + + +%package -n python3-annexremote +Summary: git annex special remotes made easy +Provides: python-annexremote +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-annexremote +# AnnexRemote +Helper module to easily develop special remotes for [git annex](https://git-annex.branchable.com). +AnnexRemote handles all the protocol stuff for you, so you can focus on the remote itself. +It implements the complete [external special remote protocol](https://git-annex.branchable.com/design/external_special_remote_protocol) +and fulfils all specifications regarding whitespaces etc. This is ensured by an excessive test suite. +Extensions to the protocol are normally added within hours after they've been published. + +[Documentation](https://lykos153.github.io/AnnexRemote/annexremote/) + +(Also have a look at the [examples](examples) and [git-annex-remote-googledrive](https://github.com/Lykos153/git-annex-remote-googledrive) which is based on AnnexRemote.) + +## Getting started +### Prerequisites +You need python3 installed on your system. + +### Installing +`pip3 install annexremote` + +### Running the tests +If you want to run the tests, copy the content of the `tests` folder to the same location as `annexremote.py`. +Then use a test discovery like [nose](http://nose.readthedocs.io) to run them. + +### Usage + +Import the necessary classes + +``` +from annexremote import Master +from annexremote import SpecialRemote +from annexremote import RemoteError +``` + +Now create your special remote class. It must subtype ``SpecialRemote`` and implement at least the 6 basic methods: + +``` +class MyRemote(SpecialRemote): + def initremote(self): + # initialize the remote, eg. create the folders + # raise RemoteError if the remote couldn't be initialized + + def prepare(self): + # prepare to be used, eg. open TCP connection, authenticate with the server etc. + # raise RemoteError if not ready to use + + def transfer_store(self, key, filename): + # store the file in `filename` to a unique location derived from `key` + # raise RemoteError if the file couldn't be stored + + def transfer_retrieve(self, key, filename): + # get the file identified by `key` and store it to `filename` + # raise RemoteError if the file couldn't be retrieved + + def checkpresent(self, key): + # return True if the key is present in the remote + # return False if the key is not present + # raise RemoteError if the presence of the key couldn't be determined, eg. in case of connection error + + def remove(self, key): + # remove the key from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error +``` + +In your ``main`` function, link your remote to the master class and initialize the protocol: + +``` +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + master.Listen() + +if __name__ == "__main__": + main() +``` + +Now save your program as ``git-annex-remote-$something`` and make it executable. + +``chmod +x git-annex-remote-$something`` +(You'll need the sheebang line ``#!/usr/bin/env python3``) + +That's it. Now you've created your special remote. + +#### Export remotes +Import and subtype `ExportRemote` instead of `SpecialRemote`: + +``` +# ... +from annexremote import ExportRemote + +class MyRemote(ExportRemote): + # implement the remote methods just like in the above example and then additionally: + + def transferexport_store(self, key, local_file, remote_file): + # store the file located at `local_file` to `remote_file` on the remote + # raise RemoteError if the file couldn't be stored + + def transferexport_retrieve(self, key, local_file, remote_file): + # get the file located at `remote_file` from the remote and store it to `local_file` + # raise RemoteError if the file couldn't be retrieved + + def checkpresentexport(self, key, remote_file): + # return True if the file `remote_file` is present in the remote + # return False if not + # raise RemoteError if the presence of the file couldn't be determined, eg. in case of connection error + + def removeexport(self, key, remote_file): + # remove the file in `remote_file` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error + + def removeexportdirectory(self, remote_directory): + # remove the directory `remote_directory` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing directory isn't considered an error + + def renameexport(self, key, filename, new_filename): + # move the remote file in `name` to `new_name` + # raise RemoteError if it couldn't be moved + +``` + +#### Logging +This module includes a StreamHandler to send log records to git annex via the special remote protocol (using DEBUG). You can use it like this: + +``` +... +import logging +... + +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + + logger = logging.getLogger() + logger.addHandler(master.LoggingHandler()) + + master.Listen() + +if __name__ == "__main__": + main() +``` + + +## License + +This project is licensed under GPLv3 - see the [LICENSE](LICENSE) file for details + + + + + +%package help +Summary: Development documents and examples for annexremote +Provides: python3-annexremote-doc +%description help +# AnnexRemote +Helper module to easily develop special remotes for [git annex](https://git-annex.branchable.com). +AnnexRemote handles all the protocol stuff for you, so you can focus on the remote itself. +It implements the complete [external special remote protocol](https://git-annex.branchable.com/design/external_special_remote_protocol) +and fulfils all specifications regarding whitespaces etc. This is ensured by an excessive test suite. +Extensions to the protocol are normally added within hours after they've been published. + +[Documentation](https://lykos153.github.io/AnnexRemote/annexremote/) + +(Also have a look at the [examples](examples) and [git-annex-remote-googledrive](https://github.com/Lykos153/git-annex-remote-googledrive) which is based on AnnexRemote.) + +## Getting started +### Prerequisites +You need python3 installed on your system. + +### Installing +`pip3 install annexremote` + +### Running the tests +If you want to run the tests, copy the content of the `tests` folder to the same location as `annexremote.py`. +Then use a test discovery like [nose](http://nose.readthedocs.io) to run them. + +### Usage + +Import the necessary classes + +``` +from annexremote import Master +from annexremote import SpecialRemote +from annexremote import RemoteError +``` + +Now create your special remote class. It must subtype ``SpecialRemote`` and implement at least the 6 basic methods: + +``` +class MyRemote(SpecialRemote): + def initremote(self): + # initialize the remote, eg. create the folders + # raise RemoteError if the remote couldn't be initialized + + def prepare(self): + # prepare to be used, eg. open TCP connection, authenticate with the server etc. + # raise RemoteError if not ready to use + + def transfer_store(self, key, filename): + # store the file in `filename` to a unique location derived from `key` + # raise RemoteError if the file couldn't be stored + + def transfer_retrieve(self, key, filename): + # get the file identified by `key` and store it to `filename` + # raise RemoteError if the file couldn't be retrieved + + def checkpresent(self, key): + # return True if the key is present in the remote + # return False if the key is not present + # raise RemoteError if the presence of the key couldn't be determined, eg. in case of connection error + + def remove(self, key): + # remove the key from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error +``` + +In your ``main`` function, link your remote to the master class and initialize the protocol: + +``` +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + master.Listen() + +if __name__ == "__main__": + main() +``` + +Now save your program as ``git-annex-remote-$something`` and make it executable. + +``chmod +x git-annex-remote-$something`` +(You'll need the sheebang line ``#!/usr/bin/env python3``) + +That's it. Now you've created your special remote. + +#### Export remotes +Import and subtype `ExportRemote` instead of `SpecialRemote`: + +``` +# ... +from annexremote import ExportRemote + +class MyRemote(ExportRemote): + # implement the remote methods just like in the above example and then additionally: + + def transferexport_store(self, key, local_file, remote_file): + # store the file located at `local_file` to `remote_file` on the remote + # raise RemoteError if the file couldn't be stored + + def transferexport_retrieve(self, key, local_file, remote_file): + # get the file located at `remote_file` from the remote and store it to `local_file` + # raise RemoteError if the file couldn't be retrieved + + def checkpresentexport(self, key, remote_file): + # return True if the file `remote_file` is present in the remote + # return False if not + # raise RemoteError if the presence of the file couldn't be determined, eg. in case of connection error + + def removeexport(self, key, remote_file): + # remove the file in `remote_file` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing key isn't considered an error + + def removeexportdirectory(self, remote_directory): + # remove the directory `remote_directory` from the remote + # raise RemoteError if it couldn't be removed + # note that removing a not existing directory isn't considered an error + + def renameexport(self, key, filename, new_filename): + # move the remote file in `name` to `new_name` + # raise RemoteError if it couldn't be moved + +``` + +#### Logging +This module includes a StreamHandler to send log records to git annex via the special remote protocol (using DEBUG). You can use it like this: + +``` +... +import logging +... + +def main(): + master = Master() + remote = MyRemote(master) + master.LinkRemote(remote) + + logger = logging.getLogger() + logger.addHandler(master.LoggingHandler()) + + master.Listen() + +if __name__ == "__main__": + main() +``` + + +## License + +This project is licensed under GPLv3 - see the [LICENSE](LICENSE) file for details + + + + + +%prep +%autosetup -n annexremote-1.6.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-annexremote -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.6.0-1 +- Package Spec generated |