Odf tools
From ODF::Wiki
| odf-tools | |
|---|---|
| {{{Screenshot}}} {{{Description}}} | |
| Information | |
| Producer: | The Open Descent Foundation |
| Developers: | D.Cent, King Lo |
| Current version: | 1.1 |
| Latest release: | 6th October 2008 |
| Operating systems: | Linux |
| Category: | Utilities |
| License: | GPL version 2 |
| Languages: | bash |
| Website: | none |
| Project page: | click here |
odf-tools originally is a collection of two bash scripts "odf-get" and "odf-upload" that enable fast and comfortable sharing of files that can seen in public on the Upload Tracker. Originally, it is only used on linux, but d3jake has written a python script doing the same on windows (see odf-tools-py in this article).
Contents |
[edit] History
D.Cent and King_Lo often had to exchange projects when they cooperated.
[edit] odf-upload
odf-upload is used to upload projects to the Upload Tracker.
odf-upload
- creats a tarball (.tar.gz) of the current directory
- copies a backup into $HOME/odf_backup
- uploads it to the Upload Tracker
- uploads a file to the tracker which tells it that you were the latest member who uploaded sources for this project
- removes temporary files
Optionally, you may choose another package name instead of the default (which is your current directory) or specify the directory to upload (default is the current directory).
[edit] odf-get
odf-get is used to download projects from the Tracker. Optionally, you can type
odf-get
- downloads a file containing the members name who uploaded the latest version of the desired version
- downloads the latest version as a tarball of the desired project from the Upload Tracker
- unpacks the tarball
- removes temporary files
Optionally, you may choose the member whose version you like of the project (in this case, the first step is skipped)
[edit] extension for PIM
For uploading a project, it would not be of much sense to upload binaries, because they are often big and contain system specific code. To prevent you from typing "make tidy" and to keep the servers clean, PIM got a target named "upload" added. Typing
make upload
first does what make tidy would do and then calls odf-upload with the current directory as project name.
[edit] odf-tools-py
| odf-tools-py | |
|---|---|
| {{{Screenshot}}} {{{Description}}} | |
| Information | |
| Producer: | The Open Descent Foundation |
| Developers: | d3jake |
| Current version: | 1.0 |
| Latest release: | 20th April 2009 |
| Operating systems: | All That Support Python |
| Category: | Utilities |
| License: | GPL version 2 |
| Languages: | Python |
| Website: | none |
| Project page: | click here |
odf-tools-py is an OS-independent odf-tools clone written by d3jake.
This project was written because the original odf-tools could not easily be used on Windows. During the development of DescentShooter there were times that members of the ODF needed to send files to each other. The previous method to do this was to upload the file(s) to an FTP server and link it because when one of the members was on Windows, the odf-tools were unusable. This rewrite of the tools allows a user of any Python supported operating system to upload and get packages from ODF's server.
Due to the vast standard library of the programming language Python, d3jake decided to rewrite the original odf-tools in it. The first version took roughly two days to program. Development was done with information on how the original odf-tools worked from this wiki page, the standard library docs for Python, and the original bash odf-tools.
At the very least, Python version 2.4 must be installed. It is unknown if the differences between the 2.x versions of Python will force the requirement of version 2.3 or 2.4. The tools were developed using version 2.5.2, and they have not been tested with version 3.x.
In version 1.0 of odf-upload-py, the script has the user account hard-coded into the script. Also, the package that is uploaded is not backed up into a specific directory, it is deleted upon the finalization of the thread.
Currently, installation on windows can be done currently only by installing the Python library. Work is being done to allow installation of only several files. Of those files two will be the scripts (odf-get-py and odf-upload-py) compiled into executables, and the others will be files required to successfully run them.
[edit] odf-tools++
odf-tools++ is a commandline project which shall rewrite odf-tools in C++ and extend it. The netcode is token from libodfs netcode. The aims are to make odf-tools faster and to make you independent of wget and wput.
The project is not completely finished, but can be downloaded on our Upload Tracker (name there is "odf-tools++").
Currently, the extension odf-info is already done. It receives raw data from the upload tracker (made with PHP) which it presents to the user - sortable by name, user, size and date.
odf-get was started but not finished because dog does not support ".tar.gz" files.
odf-upload was not begun because the tracker upload uses FTP and libodf does not support FTP at the moment.
[edit] Related Articles
- Upload Tracker
- Release thread on the ODF's forums.
- odf svn tools - share projects via ODF's SVN
