pcb-init 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87b0d377a4260f18b23001b19e2e9b4ed27f2abebdeba3ca71ac5a521e0b3830
+  data.tar.gz: ed072439bae0bebc68e61d835640e3d1bdf04c931f6222777b03a0b7b3b1b984
+SHA512:
+  metadata.gz: b59a1209267600c90ae363eb36306c149a2ec75d8227c955cf68a7721239c6cf2cf664c281f6e9a4730044a8acd0e7bb22b17d748b01262ce06b44065421e167
+  data.tar.gz: 034504d8b77f5bbd0d6508713ec545ebd9564f21595613a7bd97fc23f3746c673e916f4f1419124e0be833bba20d6124ee13e67df38cc8bc53c3ae7f88907653

data/README.md

@@ -0,0 +1,67 @@
+# pcb-init
+
+A Ruby CLI tool that scaffolds a **best-practice KiCad PCB project structure**.
+
+## Installation
+
+```bash
+gem build pcb-init.gemspec
+gem install ./pcb-init-0.1.0.gem
+```
+
+## Usage
+
+```bash
+pcb-init PROJECT_NAME
+```
+
+## Example
+
+```bash
+pcb-init my-awesome-board
+```
+
+This will create a well-organized folder structure:
+
+```
+my-awesome-board/
+├── README.md
+├── docs/
+│   └── changelog.md
+├── schematic/
+├── pcb/
+│   └── design_rules.md
+├── libraries/
+│   ├── symbols/
+│   ├── footprints/
+│   └── 3d_models/
+├── bom/
+├── manufacturing/
+│   ├── gerbers/
+│   ├── drill/
+│   ├── pick_and_place/
+│   └── panel/
+├── assembly/
+├── images/
+├── revisions/
+│   └── rev_A/
+├── firmware/
+│   ├── source/
+│   └── binaries/
+└── .gitignore
+```
+
+## Features
+
+- Clean, organized folder structure following PCB project best practices
+- Pre-configured `.gitignore` for KiCad and manufacturing files
+- Ready-to-use templates for documentation
+- No external dependencies (pure Ruby)
+
+## Requirements
+
+- Ruby ≥ 3.0
+
+## License
+
+MIT

data/bin/pcb-init

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/pcb_init'
+
+PcbInit.run(ARGV)

data/lib/pcb_init.rb

@@ -0,0 +1,162 @@
+require 'fileutils'
+
+class PcbInit
+  def self.run(argv)
+    new.run(argv)
+  end
+
+  def run(argv)
+    if argv.empty? || argv.include?('--help') || argv.include?('-h')
+      show_help
+      return
+    end
+
+    project_name = argv[0]
+
+    if Dir.exist?(project_name)
+      puts "Error: Directory '#{project_name}' already exists."
+      exit 1
+    end
+
+    create_project_structure(project_name)
+    create_files(project_name)
+    
+    puts "✓ Successfully created PCB project: #{project_name}/"
+  end
+
+  private
+
+  def show_help
+    puts <<~HELP
+      pcb-init - Scaffold a best-practice KiCad PCB project structure
+
+      Usage:
+        pcb-init PROJECT_NAME
+
+      Options:
+        -h, --help    Show this help message
+
+      Example:
+        pcb-init my-awesome-board
+    HELP
+  end
+
+  def create_project_structure(project_name)
+    directories = [
+      "#{project_name}/docs",
+      "#{project_name}/schematic",
+      "#{project_name}/pcb",
+      "#{project_name}/libraries/symbols",
+      "#{project_name}/libraries/footprints",
+      "#{project_name}/libraries/3d_models",
+      "#{project_name}/bom",
+      "#{project_name}/manufacturing/gerbers",
+      "#{project_name}/manufacturing/drill",
+      "#{project_name}/manufacturing/pick_and_place",
+      "#{project_name}/manufacturing/panel",
+      "#{project_name}/assembly",
+      "#{project_name}/images",
+      "#{project_name}/revisions/rev_A",
+      "#{project_name}/firmware/source",
+      "#{project_name}/firmware/binaries"
+    ]
+
+    directories.each do |dir|
+      FileUtils.mkdir_p(dir)
+    end
+  end
+
+  def create_files(project_name)
+    create_readme(project_name)
+    create_changelog(project_name)
+    create_design_rules(project_name)
+    create_gitignore(project_name)
+  end
+
+  def create_readme(project_name)
+    content = <<~README
+      # #{project_name}
+
+      PCB project description goes here.
+    README
+
+    File.write("#{project_name}/README.md", content)
+  end
+
+  def create_changelog(project_name)
+    content = <<~CHANGELOG
+      # Changelog
+
+      ## Rev A
+
+      - Initial project setup
+    CHANGELOG
+
+    File.write("#{project_name}/docs/changelog.md", content)
+  end
+
+  def create_design_rules(project_name)
+    content = <<~DESIGN_RULES
+      # Design Rules
+
+      ## PCB Specifications
+
+      - Minimum trace width: TBD
+      - Minimum via size: TBD
+      - Board thickness: TBD
+      - Layer count: TBD
+
+      ## Manufacturing Notes
+
+      Add your design rules and constraints here.
+    DESIGN_RULES
+
+    File.write("#{project_name}/pcb/design_rules.md", content)
+  end
+
+  def create_gitignore(project_name)
+    content = <<~GITIGNORE
+      # KiCad project files
+      *.kicad_pcb-bak
+      *.kicad_sch-bak
+      *.kicad_prl
+      *.kicad_pro
+      *.kicad_dru
+      *.kicad_wks
+      *.kicad_pcb
+      *.kicad_sch
+      *.net
+      *.dsn
+      *.ses
+      *.xml
+      *.lst
+      *.rpt
+      *.erc
+      *.drc
+      *.kicad_mod
+      *.kicad_sym
+      cache.lib
+      fp-lib-table
+      sym-lib-table
+
+      # Manufacturing outputs
+      *.gbr
+      *.drl
+      *.gbrjob
+      *.zip
+      *.tar.gz
+
+      # Assembly files
+      *.pos
+      *.csv
+      *.bom
+
+      # Temporary files
+      *~
+      .DS_Store
+      Thumbs.db
+    GITIGNORE
+
+    File.write("#{project_name}/.gitignore", content)
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: pcb-init
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colthedeveloper
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby CLI tool that generates a well-organized folder structure for
+  KiCad PCB projects
+email:
+- colakunleumaru@gmail.com
+executables:
+- pcb-init
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/pcb-init
+- lib/pcb_init.rb
+homepage: https://github.com/colthedeveloper/pcb-init
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Scaffold a best-practice KiCad PCB project structure
+test_files: []