academic file converter

中文

Konverter File Akademik

Impor publikasi dan notebook Jupyter dengan mudah ke situs web atau buku yang diformat penurunan harga Anda

Fitur

• Impor Jupyter Notebook sebagai posting blog atau bab buku
• Publikasi Impor (seperti buku, proses konferensi, dan jurnal ) dari manajer referensi Anda ke situs web atau buku yang diformat penurunan harga
  • Cukup ekspor file BibTex dari manajer referensi Anda, seperti Zotero, dan berikan ini sebagai input ke alat konverter
• Kompatibel dengan semua generator situs web statis seperti berikutnya, Astro, Gatsby, Hugo, dll.
• Mudah digunakan - 100% Python, tidak ada ketergantungan pada perangkat lunak yang kompleks seperti Pandoc
• Otomatis Konversi File Menggunakan Tindakan GitHub

Masyarakat

• Lihat dokumentasi di bawah ini
• Obrolan langsung dengan komunitas di Perselisihan
• ? Twitter: @GetResearchDev @Georgecushen #MadewithAcademic

❤️ Dukung penelitian terbuka & open source

Kami sedang dalam misi untuk menumbuhkan penelitian terbuka dengan mengembangkan alat open source seperti ini.

Untuk membantu kami mengembangkan perangkat lunak open source ini secara berkelanjutan di bawah lisensi MIT, kami meminta semua individu dan bisnis yang menggunakannya untuk membantu mendukung pemeliharaan dan pengembangan yang berkelanjutan melalui sponsor dan berkontribusi.

Dukung Gerakan Penelitian Terbuka:

• ️ Bintang proyek ini di GitHub
• ❤️ Menjadi sponsor GitHub dan buka tunjangan
• ☕️ Donasi kopi
• ? ‍ berkontribusi

Instalasi

Buka Aplikasi Terminal atau Perintah Prompt Anda dan masukkan salah satu perintah instalasi di bawah ini.

Dengan pipx

Untuk instalasi termudah , instal dengan PIPX:

 pipx install academic

PIPX akan secara otomatis menginstal versi Python yang diperlukan untuk Anda di lingkungan khusus.

Dengan pip

Untuk menginstal menggunakan alat PIP Python, pastikan Anda menginstal Python 3.11+ dan kemudian jalankan:

 pip3 install -U academic

Penggunaan

Buka baris perintah atau aplikasi terminal Anda dan gunakan perintah cd untuk menavigasi ke folder yang berisi file yang ingin Anda konversi, misalnya:

 cd ~/Documents/my_website

Publikasi Impor

Unduh referensi dari manajer referensi Anda, seperti Zotero, dalam format Bibtex.

Katakanlah kami mengunduh publikasi kami ke file bernama my_publications.bib di dalam folder situs web, mari kita impor ke dalam content/publication/ folder:

 academic import my_publications.bib content/publication/ --compact

Argumen opsional:

• --compact menghasilkan penurunan harga minimal tanpa komentar atau kunci kosong
• --overwrite menimpa publikasi yang ada di folder output
• --normalize menormalkan tag dengan mengubahnya menjadi huruf kecil dan memanfaatkan huruf pertama (misalnya "sains" -> "sains")
• --featured fitur Publikasi ini sebagai unggulan (untuk muncul di bagian publikasi unggulan situs web Anda)
• --verbose atau -v menampilkan pesan verbose
• --help tolong

Impor Teks Lengkap dan Gambar Sampul

Setelah mengimpor publikasi, kami sarankan Anda:

• Edit Badan Markdown dari setiap publikasi untuk menambahkan teks lengkap langsung ke halaman (jika publikasi adalah akses terbuka), atau sebaliknya, untuk menambahkan catatan tambahan untuk setiap publikasi
• Tambahkan gambar bernama featured untuk setiap folder publikasi untuk secara visual mewakili publikasi Anda di halaman dan untuk berbagi di media sosial
• Tambahkan PDF publikasi ke setiap folder publikasi (untuk publikasi akses terbuka), untuk memungkinkan pengunjung situs web Anda mengunduh publikasi Anda

Pelajari lebih lanjut di dokumen Hugo Blox.

Impor posting blog dari jupyter notebooks

Katakanlah kami memiliki buku catatan kami di folder notebooks di dalam folder situs web, mari kita impor ke dalam content/post/ folder:

 academic import 'notebooks/*.ipynb' content/post/ --verbose

Argumen opsional:

• --overwrite menimpa posting blog yang ada di folder output
• --verbose atau -v menampilkan pesan verbose
• --help tolong

Menyumbang

Tertarik berkontribusi pada open source dan riset terbuka ?

Pelajari cara berkontribusi kode di GitHub.

Lihatlah masalah terbuka dan berkontribusi permintaan tarik.

Untuk pengembangan lokal, klon repositori ini dan gunakan puisi untuk menginstal dan menjalankan konverter menggunakan perintah berikut:

 git clone https://github.com/GetRD/academic-file-converter.git
cd academic-file-converter
poetry install
poetry run academic import tests/data/article.bib output/publication/ --overwrite --compact
poetry run academic import 'tests/data/**/*.ipynb' output/post/ --overwrite --verbose

Saat menyiapkan kontribusi, jalankan cek berikut dan pastikan semuanya lewat:

• LINT: make lint
• Format: make format
• Tes: make test
• Ketik Periksa: make type

Membantu beta menguji versi dev

Anda dapat membantu menguji versi pengembangan terbaru dengan menginstal cabang main terbaru dari GitHub:

 pip3 install -U git+https://github.com/GetRD/academic-file-converter.git

Lisensi

Hak Cipta 2018-sekarang George Cushen.

Berlisensi di bawah lisensi MIT.