jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

Related tags

General Utilitiesjfc
Overview

Journal Fabulous Club

jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

demo

Install

Consider using pipx.

pipx install git+https://github.com/mikeevmm/jfc/

Otherwise, if you are using pip:

pip install git+https://github.com/mikeevmm/jfc/

How to Use

jfc aggregates unseen articles from the specified timeframe (see the configuration section), and displays them to you in an interactive prompt. From the title, you can choose to read the abstract, and from there you can choose to open the ArXiv PDF.

Run jfc to get an interactive prompt.

Configuration

jfc has some configuration parameters, which are set in the TOML file that lives in the configuration directory (as reported by appdirs).

Running jfc config will output the full path of the configuration file. Since most editors accept a path as an argument for the file to open, this means you can quickly edit the configuration (in bash) with

<your favourite editor> $(jfc config)

To clean the configuration and/or article database, run one of

jfc clean conf
jfc clean db
jfc clean all

A copy of the old files is kept with a .old extension, so that these can be recovered. In particular, your old configuration can be recovered (in bash) with

mv "$(jfc config).old" "$(jfc config)"

Parameters

  • span The timeframe of publication dates to aggregate, in days, and counting backwards from today. [Default: 7]
  • show_header Whether to be boring (false) or not (true) [Default: true]
  • [categories] Set each item below it to true to include it in the ArXiv search. Every element defaults to false, except quant-ph, which defaults to true.
    • cs
    • econ
    • eess
    • math
    • astro-ph
    • cond-mat
    • gr-qc
    • hep-ex
    • hep-lat
    • hep-ph
    • hep-th
    • math-ph
    • nlin
    • nucl-ex
    • nucl-th
    • physics
    • quant-ph
    • q-bio
    • q-fin
    • stat

Contributing

Pull requests are welcome. Issues are not guaranteed to be addressed. jfc is built primarily for self-use, provided to you for free, and not my primary occupation. Please respect this.

Licence

jfc is licenced under a GNU General Public License, version 3. This informally means that:

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

You can find a copy of the licence under LICENCE.

Support

We're all poor students, so we know how this goes. Nonetheless, getting donations, no matter how small, lets me know that people use and appreciate the software I've published.

💕 If you like and use jfc, consider buying me a coffee.

Owner
Miguel M.
Hi, nice to meet you. I study physics, program (games) and make music. You can find my portfolio below!
Miguel M.
Helpful functions for use alongside the rich Python library.

🔧 Rich Tools A python package with helpful functions for use alongside with the rich python library. 󠀠󠀠 The current features are: Convert a Pandas

Avi Perl 14 Oct 14, 2022
Python Random Number Genrator

This Genrates Random Numbers. This Random Number Generator was made using python. This software uses Time and Random extension. Download the EXE file and run it to get your answer.

Krish Sethi 2 Feb 03, 2022
cssOrganizer - organize a css file by grouping them into categories

This python project was created to scan through a CSS file and produce a more organized CSS file by grouping related CSS Properties within selectors. Created in my spare time for fun and my own utili

Andrew Espindola 0 Aug 31, 2022
Macro recording and metaprogramming in Python

macro-kit is a package for efficient macro recording and metaprogramming in Python using abstract syntax tree (AST).

8 Aug 31, 2022
PyHook is an offensive API hooking tool written in python designed to catch various credentials within the API call.

PyHook is the python implementation of my SharpHook project, It uses various API hooks in order to give us the desired credentials. PyHook Uses

Ilan Kalendarov 158 Dec 22, 2022
Generate random german words

Generate random german words / Generiere zufällige deutsche Wörter Getting Started Pip install with pip install zufallsworte Install the library with

Maximilian Freitag 5 Mar 24, 2022
Obsidian tools - a Python package for analysing an Obsidian.md vault

obsidiantools is a Python package for getting structured metadata about your Obsidian.md notes and analysing your vault.

Mark Farragher 153 Jan 04, 2023
Astvuln is a simple AST scanner which recursively scans a directory, parses each file as AST and runs specified method.

Astvuln Astvuln is a simple AST scanner which recursively scans a directory, parses each file as AST and runs specified method. Some search methods ar

Bitstamp Security 7 May 29, 2022
A library to easily convert climbing route grades between different grading systems.

pyclimb A library to easily convert climbing route grades between different grading systems. In rock climbing, mountaineering, and other climbing disc

Ilias Antonopoulos 4 Jan 26, 2022
A collection of custom scripts for working with Quake assets.

Custom Quake Tools A collection of custom scripts for working with Quake assets. Features Script to list all BSP files in a Quake mod

Jason Brownlee 3 Jul 05, 2022
Adding two matrix from scratch using python.

Adding-two-matrix-from-scratch-using-python. Here, I have take two matrix from user and add it without using any library. I made this program from scr

Sachin Vinayak Dabhade 4 Sep 24, 2021
A program will generate a eth key pair that has the public key that starts with a defined amount of 0

ETHAdressGenerator This short program will generate a eth key pair that has the public key that starts with a defined amount of 0 Requirements Python

3 Nov 19, 2021
A simulator for xkcd 2529's weirdly concrete problem

What is this? This is a quick hack implementation of a simulator for xkcd 2529's weirdly concrete problem. This is barely tested and I suck at computa

Reuben Steenekamp 6 Oct 27, 2021
🌲 A simple BST (Binary Search Tree) generator written in python

Tree-Traversals (BST) 🌲 A simple BST (Binary Search Tree) generator written in python Installation Use the package manager pip to install BST. Usage

Jan Kupczyk 1 Dec 12, 2021
async parser for JET

This project is mainly aims to provide an async parsing option for NTDS.dit database file for obtaining user secrets.

15 Mar 08, 2022
jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

jfc is an utility to make reviewing ArXiv papers for your Journal Club easier.

Miguel M. 3 Dec 20, 2021
Factoral Methods using two different method

Factoral-Methods-using-two-different-method Here, I am finding the factorial of a number by using two different method. The first method is by using f

Sachin Vinayak Dabhade 4 Sep 24, 2021
python-codicefiscale: a tiny library for encode/decode Italian fiscal code - codifica/decodifica del Codice Fiscale.

python-codicefiscale python-codicefiscale is a tiny library for encode/decode Italian fiscal code - codifica/decodifica del Codice Fiscale. Features T

Fabio Caccamo 53 Dec 14, 2022
Package that allows for validate and sanitize of string values.

py.validator A library of string validators and sanitizers Insipired by validator.js Strings only This library validates and sanitizes strings only. P

Sanel Hadzini 22 Nov 08, 2022
Local backup made easy, with Python and shutil

KTBackup BETA Local backup made easy, with Python and shutil Features One-command backup and restore Minimalistic (only using stdlib) Convenient direc

kelptaken 1 Dec 27, 2021