gai18n 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80ea1d6a4a1a9340d8149b99546887182e9e8c8111e5d97aabc3443e495e7518
+  data.tar.gz: 87973911b51f123a2a49b1729dc97385bffeee649663dd5fda836f2537f64b10
+SHA512:
+  metadata.gz: bcde0839b720b180d9e97cddccc3a8de21e05a2cd2094054f6015f87c87248bcd61a8e7fbb1c4502e7678b7cc1c53ea835cf01b9f24a31c3afc0b93a8e0daf03
+  data.tar.gz: 713b081ea1ac3d8b1b2d20be55a7e5f6f307fc81a51ac9411de7680def97eee5a829f0626a2d50632f21569583c3547f5d42a73bb3cde26c22460887a90000e4

data/README.md

@@ -0,0 +1,94 @@
+# GAI18n
+
+GAI18n uses OpenAI's Assistant API to translate source language files to target
+language files. It is packaged as a gem and should work well in Rails or plain
+Ruby applications.
+
+## Setup
+
+### Install the gem
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gai18n'
+```
+
+Then install the gem by running the following command:
+```bash
+$ bundle install
+```
+
+### Initial Setup
+
+Please add the gai18n.rb configuration file. You can do this
+by running the following command, `bundle exec gai18n setup`.
+
+```bash
+# generate the gai18n.rb configuration file. If you have a `config` directory,
+# gai18n.rb file will be created in that directory. Otherwise, it will be
+# created in the current project directory.
+$ bundle exec gai18n setup
+
+
+# Same as the above, but it will also set the OpenAI secret key in the file.
+$ bundle exec gai18n setup -s your_openai_secret_key
+```
+
+Ensure the `gai18n.rb` configuration file is set up with your
+`openai_secret_key`. Then you can run the following command to create an
+Assistant in your OpenAI account and set the Assistant id in the configuration.
+
+```bash
+$ bundle exec gai18n assistant:create
+```
+
+Copy the Assistant id from the command's response and set it in the `gai18n.rb`
+configuration file.
+
+NOTE: Do not use an Assistant that was created separately. It must be created
+by the `bundle exec gai18n assistant:create` command due to the unique
+instructions required for the Assistant to work with this gem.
+
+## Usage
+
+To translate your source language file(s) to the target language file(s), run:
+
+```ruby
+$ bundle exec gai18n translate
+```
+
+This will translate the source language file(s) to the target language file(s)
+and save the translated content in the target language file(s). The source
+language file(s) will not be modified. The translated content will be merged
+with the existing content in the target language file(s) or create a new
+target language file(s) if it does not exist.
+
+## Configuration
+
+For all configuration options, please see the `gai18n.rb` file that was created
+during the setup process. It contains annotations for each configuration option.
+
+# Contributing
+
+Bug reports and pull requests are welcome.
+
+To get started:
+- Fork the repository
+- Clone the repository to your local machine
+- cd into this directory and run `bundle install`
+- Make your changes
+- Run the tests with `bundle exec rake`
+- Commit your changes
+- Push your changes to your fork
+- Open a pull request to this repository
+
+# Code of Conduct
+
+This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--pattern spec/**/*_spec.rb'
+end
+
+task default: %i[spec]

data/bin/gai18n

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'gai18n'
+require 'gai18n/cli'
+
+GAI18n::CLI.new.run(ARGV)

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: gai18n
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Q Nguyen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Generative AI to generate I18n translations.
+email:
+- supertaru@gmail.com
+executables:
+- gai18n
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/gai18n
+homepage: https://github.com/philipqnguyen/gai18n
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Generative AI for I18n
+test_files: []