Este articulo necesita una revisión editorial. Cómo puedes ayudar.
Requerimientos previos
Para desarrollar add-ons usando el SDK Add-o, necesitaras:
- Python 2.5, 2.6 o 2.7. Hay que tener encuenta que las versiones 3.x de Python no son soportadas en ninguna plataforma. Asegurte que Python se encuentre en la ruta del sistema.
- Firefox.
- El propio SDK: puedes decargar la última versión estable del SDK como un tarball o como un archivo zip.
Instalación
Instalación en OS X, FreeBSD, Linux
Extrae el contenido del archivo en el lugar de tu preferencia, y navega hasta el directorio principal del SDK con una shell/command prompt. Por ejemplo:
tar -xf addon-sdk.tar.gz cd addon-sdk
Luego, si eres un usuario Bash, ejecuta:
source bin/activate
Si no eres un usuario Bash, debes ejecutar:
bash bin/activate
En la línea de entrada de tu terminal ahora deberías tener un prefijo con el nombre del directorio raíz del SDK:
(addon-sdk)~/mozilla/addon-sdk >
La orden activate establece algunas variables de entorno necesarias para el SDK. Establece las variables solo para la terminal actual. Si abres una terminal nueva, el SDK no estará activo hasta que ejecutes nuevamente activate. Si deseas una activación permanente, dirigete a Establecer activate permanentemente mas abajo.
Instalación en OS X usando Homebrew
Si usas Mac, puedes usar Homebrew para instalar el SDK, usando la siguiente orden:
brew install mozilla-addon-sdk
Una vez que el proceso se haya completado satisfactoriamente, puedes usar el programa cfx en tu línea de órdenes en cualquier momento: no necesitas ejecutar bin/activate.
Instalación en Windows
Extrae el contenido del archivo en el lugar de tu peferencia, y navega hasta el directorio principal de SDK con la terminal. Por ejemplo:
7z.exe x addon-sdk.zip cd addon-sdk
Luego ejecuta:
bin\activate
En la línea de entrada de tu terminal ahora deberías tener un prefijo con el nombre completo del directorio raíz del SDK:
(C:\Users\mozilla\sdk\addon-sdk) C:\Users\Work\sdk\addon-sdk>
La orden activate establece algunas variables de entorno necesarias para el SDK. Establece las variables solo para la terminal actual. Si abres una terminal nueva, el SDK no estará activo hasta que ejecutes nuevamente activate. Si deseas una activación permanente, dirigete a Estableciendo activate permanentemente mas abajo.
Verificar congruencia
Ejecuta esto en tu terminal:
cfxEsto debería arrojar una salida cuyas primeras lineas deberían verse algo parecido a esto, seguidas de muchas línas de información útil:
Usage: cfx [options] [command]
Este es el programa de la línea de órdnes cfx. Es tu principal interfaz con el Add-on SDK. Lo usas para ejecutar Firefox y probar tu add-on, empaquetar tu add-on para distribuirlo, ver documentación, y ejecutar pruebas unitarias.
Si no puedes ver esto, dirigete a la página Resolución de problemas.
Próximos Pasos
Ahora, dale un vistazo al tutorial Comenzando con cfx, en el cual se explica como crear add-ons usando la herramienta cfx.
Tópicos avanzados
Usar el SDK desde Git
El SDK es desarrollado en GitHub. En vez de usar versiones en archivos comprimidos, puedes echar un vistazo al repositorio GitHub: con esto puedes usar la última versión de desarrollo en vez de usar el lanzamiento oficial.
Si usas la última versión de desarrollo, debes usarla con la versión Nightly de Firefox, y no podrás enviar a addons.mozilla.org (AMO) ningún add-ons que desarrolles, porque AMO solicita que uses el lanzamiento oficial.
Desarrollar add-ons para AMO desde Git
Si deseas desarrollar add-ons que puedan ser admitidos en AMO usando Git, entonces deberás:
- usar el último lanzamiento etiquetado en git de las fuentes de addon-sdk
- ejecutar la orden
git archivepara ampliar algunos atributos de marcado de posición de git dentro de un directorio activo clonado de git.
git checkout 1.17 git archive 1.17 python-lib/cuddlefish/_version.py | tar -xvf -
Establecer activate permanentemente
La orden activate establece algunas variables de entorno necesarias para el SDK. Establece las variables solo para la terminal actual. Si abres una terminal nueva, el SDK no estará activo hasta que ejecutes nuevamente activate.
Esto significa que puedes tener multiples copias del SDK en diferentes partes del disco y cambiar entre ellas, o incluso tenerlas activas al mismo tiempo en diferentes terminales.
Estableciendo estas variables de forma permanente en tu entorno para que cada nueva terminal pueda leerlas, podrás hacer que la activación sea permanente. Por lo tanto no tendrás que ejecutar activate cada vez que habrás una nueva terminal.
Debido a que el conjunto exacto de variables pueden cambiar en nuevas versiones del SDK, lo mejor es consultar la secuencia de órdenes de activación para determinar cuales variables deben ser establecidas. La activación usa diferentes secuencias de órdenes de activación para entornos bash (Linux and OS X) y ambientes Windows .
Windows
En Windows, bin\activate usa activate.bat, y puedes hacer la activación permanente usando la herramienta setx de la terminal o el Panel de Control.
Pasos para el establecimiento permanente:
Paso 0. Abre el Panel de Control > Sistema > Avanzado > Variables de Entorno.
Paso 1. Agrega el directorio Python y el directorio SDK\bin a la Variable de la Ruta del Sistema.
Path=...;C:\PYTHON26\;C:\Users\Omid\Documents\FirefoxAddons\addon-sdk-1.15\bin
Paso 2. Agrega una Variable de usuario llamada CUDDLEFISH_ROOT y establece su valor a "C:\Users\Omid\Documents\FirefoxAddons\addon-sdk-1.15"
Paso 3. Agrega una Variable de usuario llamada PYTHONPATH y establece su valor a "C:\Users\Omid\Documents\FirefoxAddons\addon-sdk-1.15\python-lib"
Paso 4. Agrega una Variable de usuario llamada VIRTUAL_ENV y establece su valor a "C:\Users\Omid\Documents\FirefoxAddons\addon-sdk-1.15"
Linux / OS X
En Linux y OS X, source bin/activate usan la secuencia de órdenes bash activate, y puedes hacer la activación permanente usando tu ~/.bashrc (en Linux) o ~/.bashprofile (en OS X).
Como alternativa a esto, puedes crear un enlace simbólico al programa cfx en tu directorio ~/bin:
ln -s PATH_TO_SDK/bin/cfx ~/bin/cfx
Si usaste Homebrew para instalar SDK, las variables de entorno ya estan establecidas permanentemente.