Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Latest commit

 

History

History
100 lines (66 loc) · 4.8 KB

README.md

File metadata and controls

100 lines (66 loc) · 4.8 KB
Raw

Clone all Assembla repos

There are three python scripts in this repo:

  1. clone_assembla_repos.py: This is a Python script that clones all your available Assembla repos.
  2. get_assembla_tickets.py: This is a Python script that grabs all the tickets in your Assembla spaces.
  3. get_assembla_documents.py: This is a Python script that grabs all the documents/attachments in your Assembla spaces.

Cloning Assembla repos

How to use this script

1. Install all the requirements

In your terminal run pip install -r requirements.txt. It may also be a good idea to setup a virtual environment before doing so.

2. Register a new personal key in Assembla.

To register a personal key in Assembla you will need to sign into your account and then go to Account Information > Security > API Application & Sessions. As of 9 Aug 2023, the direct link is https://app.assembla.com/user/edit/manage_clients. Under "Register new personal key", give your key a description and tick "API access" and "Repository access"

3. Add your API credentials to the Python script

Create a .env file in the root directory of the project. In this file paste the following lines:

ASSEMBLA_KEY="<key>"
ASSEMBLA_SECRET="<secret>"

where <key> is your key and secret is your secret.

For example, if your key was 1234 and your secret was 5678 then your code would like like this:

ASSEMBLA_KEY="1234"
ASSEMBLA_SECRET="5678"

4. Run the script

Run the script by running python clone_assembla_repos.py. This will then clone all your repos into your directory.

How the script works

  1. The script grabs the JSON list of your spaces and spits out a list of all the Space IDs.
  2. It then takes that list of Space IDs and for each space it makes a call to the Assembla API to get the repos for that space.
  3. It then compiles a JSON file of all the repos that is has gathered.
  4. That list of repos has a lot of information we don't need so the next step is to pull out just the repo URLs.
  5. Using this list, it runs git clone --mirror <repo url> in your terminal and clones all the repos into the root of this folder.

Get Assembla tickets

How to use this script

1. Follow steps 1–3 in the above

2. Run the script

Run the script by running python get_assembla_tickets.py. This will then create a JSON file of all your tickets in /data.

3. Get the exported files from /data.

Understanding the data

Running the get_assembla_tickets.py script will output three JSON files:

  1. users_spaces.json – a list of all the information associated with every space a user is a member of.
  2. users_tickets.json – a list of all the tickets in each of the user's spaces.
  3. users_ticket_comments.json – a list of all the comments associated with each ticket.

users_spaces.json holds the unique space_id for each space. To see all the tickets associated with that space, grab that space_id and then search for it in the users_tickets.json file. Similarly, to see all the comments associated with a ticket, first grab the ticket id from users_tickets.json. Then use that id to search for the relevant comments in users_tickets_comments.json

Get documents

1. Follow steps 1–3 in the above

2. Run the script

Run the script by running python get_assembla_docs.py.

3. Get the exported files from /data/documents.

Understanding the data

Running the script will do three things:

  1. Create a file in /data called users_spaces.json
  2. Create another file in /data called users_documents.json
  3. Download all the documents into /data/documents

Each document will be named with its unique id. For example, if the document is a PNG, and it's UID is 1234, then the file will be named 1234.png. This UID can be found in the users_documents.json file, which also contains other information such as what space it belongs to and which ticket it is associated with.

Restoring to a new Git host

The Assembla repositories are fetched with --mirror so they contain all the branch data. If you create a new repository somewhere else (eg. GitHub), then you can add that one as a second remote, something like this:

git remote add new_origin https://github.com/<username>/<repository>.git

Once you've done that then you can push all the branches to that new repository with:

git push new_origin --mirror

The git repository as mirrored from Assembla can contain some empty folders, notably refs/heads and refs/tags and without these folders git commands don't work properly.

If you're archiving the Assembla repositories into S3 for exmaple, you should note that it doesn't normally keep a record of empty folders, so refs/heads and refs/tags won't reappear when you restore your archive from S3. So it's probably wise to zip the repositories before archiving.