Memulai Library Data Python Google

Jeffrey Scudder, Tim Google Data API
Agustus 2007

Pengantar

Jadi, Anda memutuskan untuk menggunakan library klien Google Data Python untuk menulis aplikasi menggunakan salah satu dari banyak layanan Data Google. Pilihan yang luar biasa! Tujuan saya untuk tutorial singkat ini adalah untuk membantu Anda mulai menggunakan library klien dengan cepat untuk mengembangkan aplikasi Anda.

Anda mungkin ingin bergabung dan langsung membuat aplikasi. Namun, Anda mungkin perlu mengonfigurasi lingkungan pengembangan dan menyiapkan alat yang Anda perlukan untuk menjalankan modul yang disertakan dalam library klien. Ikuti langkah-langkah di bawah ini dan Anda akan segera menjalankan kode.

Menginstal Python

Jika akan melakukan pengembangan dengan library klien Python, Anda memerlukan versi Python 2.2 atau yang lebih tinggi yang berfungsi. Banyak sistem operasi menyertakan versi Python, sehingga Anda mungkin dapat melewati langkah penginstalan. Untuk melihat versi Python yang Anda miliki, jalankan python -V di terminal command line. (Catatan: V menggunakan huruf besar.) Perintah ini akan menghasilkan hal seperti:

Python 2.4.3

Jika melihat versi 2.2 atau yang lebih baru, Anda dapat mulai menginstal dependensi. Jika tidak, lihat di bawah ini untuk menemukan petunjuk penginstalan/upgrade untuk sistem operasi Anda.

Menginstal Python di Windows

Ada beberapa implementasi Python yang dapat dipilih di Windows, tetapi untuk tujuan panduan ini, saya akan menggunakan penginstal .msi yang ditemukan di python.org.

  1. Mulai dengan mendownload installer dari halaman download Python.
  2. Jalankan penginstal - Anda dapat menerima semua setelan default
  3. Untuk mengetahui apakah penginstalan Anda berfungsi seperti yang diharapkan, buka command prompt dan jalankan python -V.

Menginstal Python di Mac OS X

Daftar download di python.org memiliki penginstal .dmg untuk pengguna Mac di luar sana. Berikut adalah langkah-langkah untuk menginstal salah satunya:

  1. Buka http://www.python.org/download/mac/
  2. Pada halaman ini, download penginstal untuk versi Mac OS X yang sesuai. Catatan: Halaman penginstalan Python untuk Mac OS X 10.3.8 dan yang lebih lama berbeda dari versi Mac OS X yang lebih baru. Untuk menemukan versi OS X Anda, pilih About This Mac dari menu Apple di pojok kiri atas layar Anda.
  3. Setelah download selesai, klik dua kali file disk image baru (misalnya python-2.5-macosx.dmg) untuk memasangnya. Jika Anda menjalankan Safari, tindakan ini telah dilakukan untuk Anda.
  4. Buka image yang terpasang dan klik dua kali paket installer di dalamnya.
  5. Ikuti petunjuk penginstalan dan baca informasi serta perjanjian lisensi saat dipresentasikan kepada Anda. Sekali lagi, setelan default akan berfungsi dengan baik di sini.
  6. Verifikasi penginstalan dengan membuka Terminal.app (di /Applications/Utilities) dan menjalankan python -V. Versi penginstalan akan muncul.

Menginstal Python di Linux

Untuk menginstal pada Linux dan sistem operasi *nix style lainnya, saya memilih untuk mendownload kode sumber dan mengompilasinya. Namun, Anda mungkin dapat menggunakan pengelola paket favorit Anda untuk menginstal Python. (Misalnya, pada Ubuntu, hal ini dapat semudah menjalankan sudo apt-get install python pada command line.) Untuk menginstal dari sumber, ikuti langkah-langkah ini:

  1. Download tarball sumber dari halaman download Python.
  2. Setelah mendownload paket, ekstrak paket menggunakan command line. Anda dapat menggunakan 
    tar zxvf Python-2.<Your version>.tgz
    berikut
  3. Berikutnya, Anda harus mengompilasi dan menginstal kode sumber untuk penafsir Python. Di direktori yang didekompresi, jalankan ./configure untuk membuat makefile.
  4. Kemudian, jalankan make. Tindakan ini akan membuat file Python yang dapat dieksekusi berfungsi di direktori lokal. Jika Anda tidak memiliki izin root atau hanya ingin menggunakan Python dari direktori beranda Anda, Anda dapat berhenti di sini. Anda dapat menjalankan Python dari direktori ini, jadi sebaiknya tambahkan ke variabel lingkungan PATH Anda.
  5. Saya lebih memilih untuk menginstal Python di /usr/bin/ tempat sebagian besar skrip Python mencari penafsir. Jika Anda memiliki akses root, jalankan make install sebagai root. Tindakan ini akan menginstal Python di lokasi default dan akan dapat digunakan oleh semua orang di mesin Anda.
  6. Periksa apakah penginstalan berfungsi seperti yang diharapkan dengan membuka terminal dan menjalankan python -V.

Menginstal Dependensi

Saat ini, satu-satunya dependensi eksternal adalah library XML bernama ElementTree. Jika menggunakan Python versi 2.5 atau yang lebih baru, Anda tidak perlu menginstal ElementTree karena disertakan dengan paket Python.

Untuk melihat apakah ElementTree sudah ada di sistem Anda, lakukan hal berikut:

  1. Jalankan penafsir Python. Saya biasanya melakukan ini dengan menjalankan python pada command line.
  2. Coba impor modul ElementTree. Jika Anda menggunakan Python 2.5 atau yang lebih tinggi, masukkan kode berikut di penafsir: 
    from xml.etree import ElementTree
    Untuk versi yang lebih lama, masukkan: 
    from elementtree import ElementTree
  3. Jika impor gagal, Anda harus melanjutkan membaca bagian ini. Jika berhasil, Anda dapat langsung membuka Menginstal library Data Google.
  4. Download versi yang sesuai untuk sistem operasi Anda. Misalnya, jika Anda menggunakan Windows, download elementtree-1.2.6-20050316.win32.exe. Untuk sistem operasi lain, sebaiknya download versi terkompresi.
  5. Jika Anda menggunakan library versi .tar.gz atau .zip, ekstrak paket terlebih dahulu, lalu instal dengan menjalankan ./setup.py install.

Menjalankan ./setup.py install akan mencoba mengompilasi library dan menempatkannya di direktori sistem untuk modul Python Anda. Jika tidak memiliki akses root, Anda dapat menginstal modul di direktori beranda atau lokasi alternatif dengan menjalankan ./setup.py install --home=~. Tindakan ini akan menempatkan kode di direktori utama Anda.

Ada opsi lain yang sebaiknya tidak diinstal sama sekali. Setelah membuka kompresi download, Anda akan menemukan direktori bernama elementtree. Direktori ini berisi modul yang perlu Anda impor. Saat Anda memanggil impor dari dalam Python, modul ini akan mencari modul dengan nama yang diinginkan di beberapa tempat. Tempat pertama yang terlihat adalah di direktori saat ini, jadi jika Anda selalu menjalankan kode dari satu direktori, Anda cukup menempatkan direktori elementtree di sana. Python juga akan melihat direktori yang tercantum dalam variabel lingkungan PYTHONPATH Anda. Untuk petunjuk dalam mengedit PYTHONPATH, lihat Lampiran di bagian akhir artikel ini. Sebaiknya gunakan ./setup.py install untuk elementtree.

Menginstal Library Data Google

Download library Python Data Google jika Anda belum melakukannya. Cari versi terbaru di halaman download project Python.

Setelah mendownload library, ekstrak file menggunakan unzip atau tar zxvf, bergantung pada jenis download yang Anda pilih.

Sekarang Anda siap untuk menginstal modul library sehingga dapat diimpor ke Python. Ada beberapa cara untuk melakukannya:

  • Jika Anda dapat menginstal paket yang dapat diakses semua pengguna, Anda dapat menjalankan ./setup.py install dari direktori utama arsip yang belum diekstrak.
  • Jika ingin menginstal modul ini untuk digunakan di direktori utama, Anda dapat menjalankan ./setup.py install --home=<direktori beranda>.

  • Dalam beberapa kasus, Anda tidak ingin menginstal modul sama sekali. Untuk melakukannya, ubah variabel lingkungan PYTHONPATH untuk menyertakan direktori yang berisi direktori gdata dan atom untuk library klien Google Data Python. Untuk petunjuk tentang cara mengubah PYTHONPATH, lihat Lampiran di bagian akhir artikel ini.

  • Salah satu opsi terakhir yang akan saya sebutkan adalah menyalin direktori gdata dan atom dari direktori src ke direktori mana pun yang Anda buka saat menjalankan python. Python akan terlihat di direktori saat ini ketika Anda melakukan impor, tetapi saya tidak menyarankan metode ini kecuali Anda membuat sesuatu dengan cepat dan sederhana.

Setelah menginstal library Data Google, Anda siap untuk menjalankan library tersebut untuk uji coba.

Menjalankan Pengujian dan Sampel

Distribusi library klien Python Data Google mencakup beberapa kasus pengujian yang digunakan dalam pengembangan library. Hal ini juga dapat berfungsi sebagai pemeriksaan cepat untuk memastikan bahwa dependensi dan penginstalan library Anda berfungsi. Dari direktori tingkat teratas tempat Anda mengekstrak salinan library, coba jalankan:

./tests/run_data_tests.py

Jika skrip ini berjalan dengan benar, Anda akan melihat output pada command line seperti ini:

Running all tests in module gdata_test
.......
----------------------------------------------------------------------
Ran 7 tests in 0.025s

OK

Running all tests in module atom_test
..........................................
----------------------------------------------------------------------
Ran 42 tests in 0.016s

OK

...

Jika Anda tidak melihat error apa pun saat pengujian dijalankan, berarti Anda mungkin telah menyiapkan lingkungan dengan benar. Selamat!

Sekarang Anda dapat mulai menjalankan sesuatu yang lebih menarik. Distribusi berisi direktori samples yang berisi kode yang dapat memberikan titik awal untuk menulis aplikasi Anda. Jika ingin mencoba contoh interaktif sederhana, coba jalankan ./samples/docs/docs_example.py. Contoh Google Docs List API akan meminta alamat email dan sandi untuk akun Google Anda. Jika memiliki dokumen atau spreadsheet di Google Dokumen, Anda dapat mencantumkannya dengan memasukkan 1 untuk operasi yang Anda pilih. (Jika tidak memiliki dokumen atau spreadsheet, Anda akan mengalami error 404.)

Jika ada layanan Data Google tertentu yang Anda minati, lihat contoh layanan tersebut untuk mendapatkan ide dasar tentang cara menggunakan library tersebut. Sebagian besar, tetapi tidak semua, fitur didemonstrasikan dalam kode contoh, jadi Anda mungkin ingin melihat dokumentasi untuk layanan yang akan Anda gunakan untuk mendapatkan gambaran yang jelas tentang apa yang dapat Anda lakukan dengan API.

Menulis Contoh "Halo Dunia"

Mari kita mulai dengan contoh sederhana. Berikut adalah program singkat untuk mencetak daftar semua dokumen di akun Google Dokumen Anda:

import gdata.docs.service

# Create a client class which will make HTTP requests with Google Docs server.
client = gdata.docs.service.DocsService()
# Authenticate using your Google Docs email address and password.
client.ClientLogin('jo@gmail.com', 'password')

# Query the server for an Atom feed containing a list of your documents.
documents_feed = client.GetDocumentListFeed()
# Loop through the feed and extract each document entry.
for document_entry in documents_feed.entry:
  # Display the title of the document on the command line.
  print document_entry.title.text

Simpan cuplikan kode di atas sebagai file dan jalankan, atau tempel kode ke penafsir Python untuk melihat library klien Google Data Python yang berfungsi.

Kesimpulan

Setelah menginstal dan menguji library klien Python Data Google, Anda siap untuk mulai menulis aplikasi hebat berikutnya menggunakan:

Saat Anda terus mengembangkan aplikasi, Anda mungkin mengalami masalah. Jika ya, periksa daftar referensi di bawah:

Jika Anda memikirkan fitur baru yang hebat untuk library (atau kebetulan menemukan bug), masukkan fitur tersebut di grup diskusi. Kami selalu menantikan masukan Anda.

Selamat melakukan coding :-)

Lampiran: Mengubah PYTHONPATH

Saat Anda mengimpor paket atau modul dalam Python, penafsir akan mencari file tersebut dalam serangkaian lokasi, termasuk semua direktori yang tercantum dalam variabel lingkungan PYTHONPATH. Saya sering memodifikasi PYTHONPATH agar mengarah ke modul tempat saya menyalin kode sumber untuk library yang saya gunakan. Hal ini mencegah kebutuhan untuk menginstal modul setiap kali dimodifikasi karena Python akan memuat modul secara langsung dari direktori yang berisi kode sumber yang dimodifikasi.

Sebaiknya gunakan pendekatan PYTHONPATH jika Anda membuat perubahan pada kode library klien, atau jika Anda tidak memiliki hak admin di sistem Anda. Dengan mengedit PYTHONPATH, Anda dapat menempatkan modul yang diperlukan di mana pun Anda suka.

Saya mengubah PYTHONPATH pada sistem *nix dan Mac OS X dengan menyetelnya di file konfigurasi shell .bashrc. Jika menggunakan bash shell, Anda dapat mengatur variabel dengan menambahkan baris berikut ke file ~/.bashrc Anda.

export PYTHONPATH=$PYTHONPATH:/home/<my_username>/svn/gdata-python-client/src

Kemudian, Anda dapat menerapkan perubahan ini ke sesi shell Anda saat ini dengan menjalankan source ~/.bashrc.

Untuk Windows XP, tarik Variabel Lingkungan untuk profil Anda: Panel Kontrol > Properti Sistem > Lanjutan > Variabel Lingkungan. Dari sana, Anda dapat membuat atau mengedit variabel PYTHONPATH dan menambahkan lokasi salinan library lokal Anda.